# legacydeveloper Mfg Api Devguide - Full Documentation # AccountForecast Represents the rolling forecast record of a particular account. The forecast is prepared using data directly from sales agreements, orders, and opportunities. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the account for which forecast is generated. ### DefaultAccountGrowthPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Default value of the account growth metric used to calculate forecast for the first time. - **Default value**: zero ### DefaultMarketGrowthPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Default value of the market growth metric used to calculate forecast for the first time. - **Default value**: zero ### EndDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Date till which forecast is generated and displayed for this account. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note - End Date of an active account forecast must be null. - End Date can not be updated. ### LastCalculatedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date on which forecast was last calculated, either automatically or manually. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the account forecast record. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Owner of the account. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Only the account owner can create the account forecast record. ### StartDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Date from which forecast is generated and displayed for this account. It is automatically created in active status. ### Status - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Status of the forecast record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note - There can be only 1 active account forecast at any time. - An existing account forecast must be expired before creating a new one. - Active account forecast records must be expired before deleting them. - You can’t change status from Expired to Active. - **Possible values**: - Active - Expired ### TotalAdjustedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total revenue after manual adjustments are made to the auto-calculated forecast value. ### TotalRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total revenue as calculated by the application based on forecast calculations. ## Associated Object This object has the following associated object. Unless noted, it is available in the same API version as this object. **[AccountForecastChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. # AccountForecastAdjustment Represents the manual adjustments made to forecast values for a particular account. This object is available in API version 47.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### AccountProdPeriodForecastId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Lookup to the account product period ID to which adjustments are made for forecast. ### AdjustedById - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the user who makes the adjustment. ### AdjustedByName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Name of the user who makes the adjustment. ### AdjustmentComments - **Type**: textarea - **Properties**: Nillable - **Description**: Notes provided by the user stating reason for adjustment. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Adjusted comments can be updated along with either AdjustedForecastedQuantity or AdjustedForecastedRevenue. ### AdjustmentType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: States whether adjustment is made to forecast quantity or forecast revenue. - **Possible values**: - Quantity - Revenue ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note To reset the adjusted quantity or adjusted revenue, deduct 999 from the value. This will reset the adjusted forecast quantity or adjusted forecast revenue to the auto-calculated value. ### FromValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Value before adjustment. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the adjustment is recorded as part of the edit history or not. Only last three changes, including the auto-calculated value are recorded. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the record. ### ToValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Value after adjustment. # AccountForecastPeriodMetric Represents records of account metrics which vary by period but are not specific for a product. This object is available in API version 47.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields ### AccountForecastId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the account forecast record which the period metrics are part of. ### AccountGrowthPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Expected or projected rate of growth for the account, for that particular forecast period. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### MarketGrowthPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Expected or projected rate of growth for the market, for that particular forecast period. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the record. ### PeriodId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the period as derived from the Period entity based on the fiscal year. # AccountForecastSettings Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location AccountForecastSettings values are stored in the AccountForecastSettings.accountForecastSetting file in the accountForecastSettings folder. ## Version AccountForecastSettings components are available in API version 47.0 and later. ## Fields ### accountFilterId - **Field Type**: string - **Description**: Specifies the list view having a filtered list of accounts. Only the accounts in the entered list view are eligible for account forecasting. Available in API version 49.0 and later. ### accountForecastFormulas - **Field Type**: AccountForecastFormula - **Description**: Holds the formula for quantity and revenue metrics based on sales agreements, orders, opportunities, and account metrics. This formula is not derived. It is defined by the admin user. There can be one or more formulas for every Salesforce org. ### acctPrdctPrdFrcstVolCnt - **Description**: The number of existing records in the AccountProductPeriodForecast object. Available in API version 49.0 and later. ### calculationFrequency - **Field Type**: CalculationFrequency([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. Source from which frequency of account forecast recalculation is derived. - **Possible values**: - Monthly - Quarterly - Yearly - Weekly—This value is available in API version 55.0 and later. ### displayDuration - **Field Type**: int - **Description**: Required. Number of periods for which forecast is generated and displayed. ### displayedForecastMetrics - **Field Type**: string - **Description**: Required. The quantity metrics that are selected for display in the account forecast in the specified sequence. There can be a maximum of 10 comma-separated metric names in this list. ### displayedRevenueMetrics - **Field Type**: string - **Description**: Required. The revenue metrics that are selected for display in the account forecast in the specified sequence. There can be a maximum of 10 comma-separated metric names in this list. ### editableAtStartOfPeriod - **Field Type**: boolean - **Description**: Required. Indicates whether the account forecast can be adjusted at the start of the adjustment period (true) or cannot be adjusted at the start of the adjustment period (false). ### editsAllowedFor - **Field Type**: int - **Description**: Required. Number of days from which the adjustment period is derived. ### forecastFrequency - **Field Type**: ForecastFrequency([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. Source from which frequency of account forecast generation is derived. You can select a start period from when to consider data for account forecast generation and the number of periods for which forecast is generated. - **Possible values**: - Monthly - Quarterly - Yearly - Weekly—This value is available in API version 55.0 and later. ### objectMapping - **Field Type**: [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping) - **Description**: Foreign key to [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping) that maps fields from the input object of AccountForecastSettings to fields in the output object of AccountForecastSettings. ### opportunityProbabilityEnabled - **Field Type**: boolean - **Description**: Indicates whether to use the probability of opportunities associated with accounts to calculate forecast values (true) or not use the probability of opportunities associated with accounts to calculate forecast (false). Available in API version 50.0 and later. ### primaryNotifEmailAddress - **Field Type**: string - **Description**: The email address to which notifications are sent. ### productFilterId - **Description**: Specifies the list view having a filtered list of products. Only the products in the entered list view are valid for account forecasting. Available in API version 49.0 and later. ### recalculateAllFrcstCnt - **Field Type**: int - **Description**: The number of times account forecasts are recalculated for all the eligible accounts in an org. Available in API version 49.0 and later. ### regenerateForecastCnt - **Field Type**: int - **Description**: Number of times account forecasts are regenerated for all the eligible accounts in an org. Available in API version 49.0 and later. ### salesAgreementFilterId - **Field Type**: string - **Description**: Specifies the list view having a filtered list of sales agreements. Only the sales agreements in the entered list view are eligible for account forecasting. Available in API version 50.0 and later. ### secondaryNotifEmailAddress - **Field Type**: string - **Description**: The second email address to which notifications are sent. ### startingPeriod - **Field Type**: int - **Description**: Required. Number of periods to go back from the current date for account forecast generation. ## AccountForecastFormula Holds the formula for quantity and revenue metrics based on sales agreements, orders, opportunities, and account metrics. This formula is not derived. It is defined by the admin user. There can be one or more formulas for every Salesforce org. ### endingPeriod - **Field Type**: int - **Description**: Required. The period until which the forecast formula is effective. ### formula - **Field Type**: string - **Description**: Required. The formula based on which the AccountProductPeriodForecast values are calculated. ### formulaType - **Field Type**: FormulaType([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. Source from which the formula type is derived. - **Possible values**: - QUANTITY - REVENUE ### startingPeriod - **Field Type**: int - **Description**: Required. The period from which the forecast formula is effective. ## ObjectMapping Represents a map of fields in the input object of AccountForecastSettings to fields in the output object of AccountForecastSettings. The input object is AccountProductPeriodForecast. The output object is AccountProductForecast. ### inputObject - **Field Type**: string - **Description**: Required. The input object for AccountForecastSettings. AccountProductPeriodForecast is the input object for the AccountForecastSettings. ### mappingFields - **Description**: The mapping of source object fields to target object fields for AccountForecastSettings. ### outputObject - **Field Type**: string - **Description**: Required. The output object for the AccountForecastSettings. AccountProductForecast is the output object for the AccountForecastSettings. ## ObjectMappingField A field name in the AccountProductPeriodForecast object and the corresponding field name in the AccountProductForecast object. For example, you can create a field named Profit on the AccountProductPeriodForecast object and a field named Total Profit on the AccountProductForecast object. To view these field values in the account forecast, select the input object as AccountProductPeriodForecast and the output object as AccountProductForecast. In this case, the input field is Profit and the output field is Total Profit. ### inputField - **Field Type**: string - **Description**: Required. Field in the object specified by theinputObject field in [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping). This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping). ### outputField - **Field Type**: string - **Description**: Required. Field in the object specified by the outputObject field in [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping). The field is mapped to the field name in inputField, which is a field in the object specified by the inputObject in [ObjectMapping](#mfg_accountforecastsettings_metadata_api_objectmapping). ## ListView ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects. ### booleanFilter - **Field Type**: string - **Description**: This field represents an Advanced Option for a filter. Advanced Options in filters allow you to build up filtering conditions that use a mixture of AND and OR boolean operators across multiple filter line items. For example, (1 AND 2) OR 3 finds records that match both the first two filter line items or the third. ### columns - **Field Type**: string\[\] - **Description**: The list of fields in the list view. The field name relative to the object name, for example MyCustomField\_\_c, is specified for each custom field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Field names in the ListView columns don’t always match their API name counterparts. If person accounts are enabled in your organization, standard fields merged from a contact into an account start with the PC\_ prefix, while the corresponding API name starts with the Person prefix. For example, the ListView column name is PC\_Email for a corresponding API field name of PersonEmail. ### division - **Field Type**: string - **Description**: If your organization uses divisions to segment data and you’ve got the “Affected by Divisions” permission, records in the list view must match this division. This field is only available if you’re searching all records. This field is available in API version 17.0 and later. ### filterScope - **Field Type**: [FilterScope](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_listview.htm#meta_listview/filterScope) ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. This field indicates whether you’re filtering by owner or viewing all records. ### filters - **Field Type**: [ListViewFilter](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_listview.htm#meta_listview/listViewFilter)\[\] - **Description**: The list of filter line items. ### fullName - **Field Type**: string - **Description**: Required. Inherited from [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm), this field is defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. See [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_createMetadata.htm) to see an example of this field specified for a call. ### label - **Field Type**: string - **Description**: Required. The list view name. ### language - **Field Type**: [Language](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_translations.htm#meta_translations/translation_languages) - **Description**: The language used for filtering if your organization uses the Translation Workbench and you’re using the startsWith or contains operator. The values entered as search terms must be in the same language as the filter language. For a list of valid language values, see [Language](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_translations.htm). This field is available in API version 17.0 and later. ### queue - **Field Type**: string - **Description**: The name of a queue. Objects are sometimes assigned to a queue so that the users who have access to the queue can monitor and manage them. When you create a queue, a corresponding list view is automatically created. See “Create Queues” in Salesforce Help. ### sharedTo - **Field Type**: [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharedto.htm) - **Description**: Sharing access for the list view. This field is available in API version 17.0 and later. ## Declarative Metadata Sample Definition The following is an example of a AccountForecastSettings metadata file. 12 SalesAgreementPlannedQuantity + OpportunityQuantity QUANTITY 1 0 QUARTERLY 12 OpportunityQuantity,CurrentOrdersQuantity,SalesAgreementPlannedQuantity OpportunityRevenue,CurrentOrdersRevenue,SalesAgreementPlannedRevenue true 15 MONTHLY 3 abc@example.com 0 0 xyz@example.com AccountProductPeriodForecast APPF1\_\_c APF1\_\_c AccountProductForecast The following is an example package.xml that references the previous definition. AccountProductForecast.APF1\_\_c AccountProductPeriodForecast.APPF1\_\_c CustomField \* AccountForecastSettings 47.0 ## Wildcard Support in the Manifest File ### Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # AccountForecastSettings Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations. Available in API version 47.0 and later. ## Supported SOAP Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST HTTP Methods GET, POST, PATCH, PUT ## Fields ### AcctPrdctPrdFrcstVolCnt - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Number of existing records in the AccountProductPeriodForecast object. Available in API version 49.0 and later. ### CalculationFrequency - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Restricted picklist, Sort - **Description**: Source from which frequency of account forecast recalculation is derived. - **Possible values**: - Monthly (default) - Quarterly ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The developer name for AccountForecastSettings. ### DisplayDuration - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of periods for which the forecast is generated and displayed. ### DisplayedForecastMetrics - **Type**: textarea - **Properties**: Filter, Sort - **Description**: The quantity metrics that are selected for display in the account forecast in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list. ### DisplayedRevenueMetrics - **Type**: textarea - **Properties**: Filter, Sort - **Description**: The revenue metrics that are selected for display in the account forecast in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list. ### EditsAllowedFor - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of days either during the start or the end of a period when an account forecast’s values can be edited. ### ForecastFrequency - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Restricted picklist, Sort - **Description**: Source from which frequency of account forecast generation is derived. You can select a start period from when to consider data for account forecast generation and the number of periods for which forecast is generated. - **Possible values**: - Monthly (default) - Quarterly ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The unique name used for these account forecast settings. The FullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### HasOpportunityItemSchedule - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether to use the probability of opportunity schedules associated with accounts to calculate forecast values (true) or not to use the probability of opportunities associated with accounts to calculate forecast (false). Available in API version 50.0 and later. - **Default value**: false ### HasOpportunityProbability - **Type**: boolean - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates whether to use the probability of opportunities associated with accounts to calculate forecast values (true) or not use the probability of opportunities associated with accounts to calculate forecast (false). Available in API version 50.0 and later. - **Default value**: false ### IsEditableAtStartOfPeriod - **Type**: boolean - **Properties**: Defaulted on Create, Filter, Group, Sort - **Description**: Indicates whether the account forecast can be adjusted at the start of the adjustment period (true) or cannot be adjusted at the start of the adjustment period (false). - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the account forecast settings. ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Master label for AccountForecastSettings. This internal label doesn’t get translated. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The corresponding metadata value. ### PrimaryNotifEmailAddress - **Type**: email - **Properties**: Filter, Group, Nillable, Sort - **Description**: The email address to which notifications are sent. ### RecalculateAllFrcstCnt - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of times account forecasts are recalculated for all the eligible accounts in an org. Available in API version 49.0 and later. ### RegenerateForecastCnt - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of times account forecasts are regenerated for all the eligible accounts in an org. Available in API version 49.0 and later. ### SalesAgreementFilterId - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the list view having a filtered list of sales agreements. Only the sales agreements in the entered list view are eligible for account forecasting. Available in API version 50.0 and later. ### SecondaryNotifEmailAddress - **Type**: email - **Properties**: Filter, Group, Nillable, Sort - **Description**: The second email address to which notifications are sent. ### StartingPeriod - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of periods to go back from the current date for account forecast generation. # AccountProductForecast Represents the cumulative values for planned quantities, opportunities, and orders of a sales agreement for a given product across all periods in that rolling time period. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountForecastId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the account forecast record which the account product is part of. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the product is active or not. ### IsSystemGenerated - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the record was manually inserted or system-generated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the product. ### ProductId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the product. ### TotalAdjustedForecastedQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total forecasted quantity after manual adjustments are made. ### TotalAdjustedForecastedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total forecasted revenue after manual adjustments are made. ### TotalCurrentOrdersQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total quantity derived from orders in the current period. ### TotalCurrentOrdersRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total revenue derived from orders in the current period. ### TotalForecastedQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total forecasted quantity before manual adjustments are made. ### TotalForecastedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total forecasted revenue before a manual adjustment is made. ### TotalOpportunityQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total quantity derived from opportunities in the current period. ### TotalOpportunityRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total revenue derived from opportunities in the current period. ### TotalPastOrdersQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total quantity derived from orders in the last forecast period. ### TotalPastOrdersRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total revenue derived from orders in the last forecast period. ### TotalSalesAgreementPlannedQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: Total planned quantity derived from sales agreements in the current period. ### TotalSalesAgreementPlannedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total planned revenue derived from sales agreements in the current period. # AccountProductPeriodForecast Represents the quantity and revenue information of opportunities, sales agreements, orders, and resultant forecasted quantities for a product in a particular time period of the forecast rolling period. Other than the fields AdjustedForecastQuantity and AdjustedForecastRevenue, no other fields of this object can be updated. This object is available in API version 47.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields ### AccForecastPeriodMetricId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of each account forecast period metric used in forecast formula calculations. ### AccountProductForecastId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of a specific product for which forecast is calculated for this period. ### AdjustedForecastedQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Forecasted quantity which is either auto-calculated or overwritten by a user with edit access. The user-defined value is retained along with the auto-calculated value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note AdjustedForecastQuantity cannot be updated for past schedules. ### AdjustedForecastedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Forecasted revenue which is either auto-calculated or overwritten by a user with edit access. The user-defined value is retained along with the auto-calculated value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note AdjustedForecastRevenue cannot be updated for past schedules. ### AdjustmentComments - **Type**: textarea - **Properties**: Nillable - **Description**: User-defined notes stating the reason for a manual adjustment. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Adjusted comments can be updated along with either AdjustedForecastedQuantity or AdjustedForecastedRevenue. ### CurrentOrdersQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated quantity of all active orders for this account in the current period. ### CurrentOrdersRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated revenue of all active orders for this account in the current period. ### ForecastedQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Auto-calculated quantity based on forecast formula and configurations. ### ForecastedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Auto-calculated revenue based on forecast formula and configurations. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the record is part of the forecast display period or not. ### LastCalculatedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date when the value was last calculated, either due to rolling over or through recalculation of forecast. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the record. ### OpportunityQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated quantity of all active opportunities for this account in the current period. ### OpportunityRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated revenue of all active opportunities for this account in the current period. ### PastOrdersQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated quantity of all active orders for this account in the last forecast period. ### PastOrdersRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated revenue of all active orders for this account in the last forecast period. ### PeriodId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the period as derived from the Period entity based on the fiscal year. ### SalesAgreementPlannedQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated quantity for all active sales agreements for this account in the current period. This is calculated on a pro-rata basis if the sales agreement period does not coincide with the forecast display period. ### SalesAgreementPlannedRevenue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Calculated revenue for all active sales agreements for this account in the current period. This is calculated on a pro-rata basis if the sales agreement period does not coincide with the forecast display period. ### StartDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Date on which the period starts. # AcctMgrPeriodicTargetDstr Represents the target value of each period of an account manager target. It is a foreign key to either an account manager target and an account manager target distribution. It has twelve fields for periods and twelve corresponding fields to hold the target value. This object is available in API version 49.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update() ## Fields ### AcctMgrTargetDstrId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of an AcctMgrTargetDstr object. This field is a relationship field. - **Relationship Name**: AcctMgrTargetDstr - **Refers To**: AcctMgrTargetDstr ### AcctMgrTargetId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of an account manager target. This field is a relationship field. - **Relationship Name**: AcctMgrTarget - **Relationship Type**: Master-detail - **Refers To**: AcctMgrTarget (the master object) ### FiscalPeriodId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the fiscal year for an account manager target. This field is a relationship field. - **Relationship Name**: FiscalPeriod - **Refers To**: Period ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The user-defined name of an account manager target. ### Period10Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the 10th period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period10 - **Refers To**: Period ### Period10TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 10th period of an account manager target distribution that has the measure type as Currency. ### Period10TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 10th period of an account manager target distribution that has the measure type as Other. ### Period11Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the 11th period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period11 - **Refers To**: Period ### Period11TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 11th period of an account manager target distribution that has the measure type as Currency. ### Period11TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 11th period of an account manager target distribution that has the measure type as Other. ### Period12Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the 12th period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period12 - **Refers To**: Period ### Period12TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 12th period of an account manager target distribution that has the measure type as Currency. ### Period12TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the 12th period of an account manager target distribution that has the measure type as Other. ### Period1Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the first period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period1 - **Refers To**: Period ### Period1TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the first period of an account manager target distribution that has the measure type as Currency. ### Period1TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the first period of an account manager target distribution that has the measure type as Other. ### Period2Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the second period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period2 - **Refers To**: Period ### Period2TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the second period of an account manager target distribution that has the measure type as Currency. ### Period2TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the second period of an account manager target distribution that has the measure type as Other. ### Period3Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the third period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period3 - **Refers To**: Period ### Period3TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the third period of an account manager target distribution that has the measure type as Currency. ### Period3TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the third period of an account manager target distribution that has the measure type as Other. ### Period4Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the fourth period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period4 - **Refers To**: Period ### Period4TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the fourth period of an account manager target distribution that has the measure type as Currency. ### Period4TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the fourth period of an account manager target distribution that has the measure type as Other. ### Period5Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the fifth period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period5 - **Refers To**: Period ### Period5TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the fifth period of an account manager target distribution that has the measure type as Currency. ### Period5TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the fifth period of an account manager target distribution that has the measure type as Other. ### Period6Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the sixth period of an account manager target distribution. ### Period6TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the sixth period of an account manager target distribution that has the measure type as Currency. ### Period6TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the sixth period of an account manager target distribution that has the measure type as Other. ### Period7Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the seventh period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period7 - **Refers To**: Period ### Period7TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the seventh period of an account manager target distribution that has the measure type as Currency. ### Period7TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the seventh period of an account manager target distribution that has the measure type as Other. ### Period8Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the eighth period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period8 - **Refers To**: Period ### Period8TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the eighth period of an account manager target distribution that has the measure type as Currency. ### Period8TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the eighth period of an account manager target distribution that has the measure type as Other. ### Period9Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The ID of the ninth period of an account manager target distribution. This field is a relationship field. - **Relationship Name**: Period9 - **Refers To**: Period ### Period9TargetCurrencyValue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the ninth period of an account manager target distribution that has the measure type as Currency. ### Period9TargetValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The value of the ninth period of an account manager target distribution that has the measure type as Other. ## Associated Object This object has the following associated object. Unless noted, it is available in the same API version as this object. **[AcctMgrPeriodicTargetDstrHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # AcctMgrTarget Represents a target created by an account manager. It stores the fiscal year, measure, target value, start date, end date, and assignment information of an account manager target. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignedTargetPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the parent account manager target value assigned to a team member. ### AssignedToUserId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of a user who has been assigned an account manager target. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This date is populated based on the end date of the fiscal year that is selected for an account manager target. It’s a read-only field. ### FiscalYearId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the fiscal year selected for an account manager target. It’s a read-only field. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user last referenced an account manager target record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user last viewed an account manager target record. ### Measure - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field stores the measure of an account manager target. The measure can be a custom value but it must map to at least one of the predefined measure types. The value Revenue is provided by default. ### MeasureType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: There are two predefined measure types for an account manager target. The - **Possible values**: - Currency (default) - Other ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The user-defined name of an account manager target. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of a user who owns an account manager target record. ### ParentAcctMgrTargetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the parent account manager target. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This date is populated based on the start date of the fiscal year that is selected for an account manager target. ### TargetCurrencyValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of an account manager target that has the measure type as Currency. ### TargetValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of an account manager target that has the measure type as Other. ### TeamMemberHierarchyType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The hierarchy type of team members for account manager target assignments. The - **Possible values**: - ForecastsHierarchy—Derived from the Forecasts Hierarchy. setup - ManagerHierarchy (Default)—Derived from the Manager field of a user. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. **[AcctMgrTargetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. **[AcctMgrTargetFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[AcctMgrTargetHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[AcctMgrTargetShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # AcctMgrTargetDstr Represents the account, product, and price book associated to an account manager target. It is a child object of the [AcctMgrTarget](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_target.htm "Represents a target created by an account manager. It stores the fiscal year, measure, target value, start date, end date, and assignment information of an account manager target. This object is available in API version 49.0 and later.") object. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the account selected for an account manager target distribution. ### AcctMgrTargetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of an account manager target. ### AssignedTargetPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the parent account manager target value assigned to a team member. ### ListPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The list price of a product selected for an account manager target distribution. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The user-defined name of an account manager target. ### PricebookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of a product in relation to the price book selected for an account manager target distribution. ### PricebookId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the price book selected for an account manager target distribution by product. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of a product selected for an account manager target distribution. ### TargetCurrencyValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The distribution value of an account manager target that has the measure type as Currency. ### TargetValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The distribution value of an account manager target that has the measure type as Other. ## Associated Objects This object has the following associated objects. Unless noted, it is available in the same API version as this object. **[AcctMgrTargetDstrChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. **[AcctMgrTargetDstrHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # AcctMgrTargetMeasure Represents the type of measure for an account manager target. This object is a dynamic pick list table, which is referenced in account manager target. It is available in API version 49.0 and later. ## Supported Calls describeSObjects(), query(), retrieve() ## Fields ### ApiName - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The API name of the measure type. ### IsDefault - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies whether the measure type is Currency (false) or Other (true). - **Default value**: false ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the account manager target. ### MeasureType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: This field has two predefined measure types for an account manager target. The - **Possible values**: - Currency - Other ### SortOrder - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The order of sorting the values in AcctMgrTargetMeasure. # AcctMgrTargetSettings Represents the settings of account manager targets. These settings define the distribution frequency, the hierarchy of team members for assignments, and the default price book of account manager targets. This type also displays the record usage details by account manager targets in your Salesforce org. This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location AcctMgrTargetSettings components have the suffix acctMgrTargetSetting and are stored in the acctMgrTargetSettings folder. ## Version AcctMgrTargetSettings components are available in API version 49.0 and later. ## Special Access Rules To use this metadata type, your Salesforce org must have the Manufacturing Cloud license. ## Fields ### acctMgrPeriodicTargetDstrCnt - **Field Type**: int - **Description**: The number of existing records in the AcctMgrTargetDstr object. ### periodType - **Field Type**: PeriodTypes ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. Indicates the type of period to use for an account manager target’s distribution. The - **Possible values**: - Month - Quarter - Year ### pricebookId - **Field Type**: string - **Description**: The ID of the default price book selected for an account manager target distribution by product. ### teamMemberHierarchyType - **Field Type**: TeamMemberHierarchyType ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm#meta_objects_intro/enumeration_title) of type string) - **Description**: Required. The hierarchy type of team members for account manager target assignments. The - **Possible values**: - ManagerHierarchy - ForecastsHierarchy ## Declarative Metadata Sample Definition The following is an example of a AcctMgrTargetSettings component. Month ManagerHierarchy The following is an example package.xml that references the previous definition. \* AcctMgrTargetSettings 49.0 ## Wildcard Support in the Manifest File ### Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # AcctMgrTargetSettings Represents the settings of account manager targets. These settings define the distribution frequency, the hierarchy of team members for assignments, and the default price book of account manager targets. This object also displays the record usage details by account manager targets in your Salesforce org. This object is available in API version 49.0 and later. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API HTTP Methods GET, POST, PATCH, PUT ## Fields ### AcctMgrPeriodicTargetDstrCnt - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of existing records in the AcctMgrTargetDstr object. ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The developer name for AcctMgrTargetSettings. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated metadata type in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the account manager target settings. ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The label for AcctMgrTargetSettings. This internal label doesn’t get translated. ### Metadata - **Type**: [AcctMgrTargetSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/mfg_acctMgrTargetSettings_metadata_api.htm "HTML (New Window)") - **Properties**: Create, Nillable, Update - **Description**: The corresponding metadata type. ### PeriodType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Indicates the type of period to use for account manager target’s distribution. The - **Possible values**: - Month - Quarter - Week - Year ### PricebookId - **Type**: String - **Properties**: Filter, Group, Nillable - **Description**: The ID of the price book. ### TeamMemberHierarchyType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: The hierarchy type of team members for account manager target assignments. The - **Possible values**: - ForecastsHierarchy—Derived from the Forecasts Hierarchy setup - ManagerHierarchy—Derived from the Manager field of a user # ActionableEventOrchDef Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location ActionableEventOrchDef components have the suffix .actionableEventOrchDef and are stored in the ActionableEventOrchDef folder. ## Version ActionableEventOrchDef components are available in API version 64.0 and later. ## Fields ### actionableEventUsageType - **Field Type**: string - **Description**: The usage type of the actionable event orchestration definition. - **Possible values**: - Automotive—1 - Manufacturing—2 - Standard—3 ### apiName - **Field Type**: string - **Description**: Required. The API name of the actionable event orchestration definition record. ### contextDefinitionDeveloperName - **Field Type**: string - **Description**: The developer name of a context definition that's associated with the actionable event orchestration definition. ### contextMappingTitle - **Field Type**: string - **Description**: The title of a context mapping that's associated with the actionable event orchestration definition. ### eventCategory - **Field Type**: string - **Description**: The category of an actionable event orchestration definition. ### eventSubtypeApiName - **Field Type**: string - **Description**: The API name of an actionable event orchestration definition subtype. ### eventTypeApiName - **Field Type**: string - **Description**: Required. The API name of an actionable event orchestration definition type. ### executionProcedureAPIName - **Field Type**: string - **Description**: The API name of the flow definition or the expression set template that executes the orchestration. ### executionProcedureType - **Field Type**: string - **Description**: Specifies the type of automated procedure that executes the orchestration. - **Possible values**: - ExpressionSetBasedOrchestration—1 - FlowBasedOrchestration—2 ### isActive - **Field Type**: boolean - **Description**: Required. Specifies if an actionable event orchestration definition record is active (true) or not (false). - **Default value**: false ### isTemplate - **Field Type**: boolean - **Description**: Required. Indicates whether the actionable event orchestration definition is a template (true) or not (false). The default value is false. ### label - **Field Type**: string - **Description**: Required. The label of the actionable event orchestration definition record. ## Declarative Metadata Sample Definition The following is an example of an ActionableEventOrchDef component. 1 Create\_Asset\_Registration AssetRegistrationCreateRecordDetails\_stdctx VehicleFaultEventDetailMapping Create\_Registration\_Records\_SubType Create\_Registration\_Records CreateAssetFlow 2 true Create Asset Registration The following is an example package.xml that references the previous definition. \* ActionableEventOrchDef 64.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # ActionableEventTypeDef Represents the definition of an actionable event type so that the records can be migrated from one org to another. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location ActionableEventTypeDef components have the suffix .ActionableEventTypeDef and are stored in the ActionableEventTypeDef folder. ## Version ActionableEventTypeDef components are available in API version 64.0 and later. ## Fields ### apiName - **Field Type**: string - **Description**: Required. The API name of an actionable event type definiton. ### eventSubtypes - **Field Type**: [EventSubtype\[\]](#mfg_actionableeventtypedef_metadata_api_eventsubtype) - **Description**: The subtype of an actionable event. ### label - **Field Type**: string - **Description**: Required. Label of the actionable event type definition. ## EventSubtype Represents the subtype of an external or internal event that's processed by the Actionable Event Orchestration framework to trigger different types of actions. ### apiName - **Field Type**: string - **Description**: Required. The API name of an actionable event subtype. ### label - **Field Type**: string - **Description**: Required. Label of the event subtype that represents a specific kind of external or internal actionable event. ## Declarative Metadata Sample Definition The following is an example of an ActionableEventTypeDef component. Create\_Registration\_Records Create\_Registration\_Records\_SubType reate Registration Records Subtype Create Registration Records The following is an example package.xml that references the previous definition. \* ActionableEventTypeDef 64.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # AdvAccountForecastFact Represents information about the generated advanced account forecast records. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the advanced account forecast record. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AdvAcctForecastSetPartnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account forecast set partner for which the advanced account forecast records are generated. This is a relationship field. - **Relationship Name**: AdvAcctForecastSetPartner - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastSetPartner ### AdvAcctForecastSetUseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The advanced account forecast set use that's associated with the advanced account forecast fact record. Available in API version 57.0 and later. This field is a relationship field. - **Relationship Name**: AdvAcctForecastSetUse - **Refers To**: AdvAcctForecastSetUse ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The currency used for the forecast values. ### ForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total forecasted quantity for the generated advanced account forecast set records. ### ForecastedRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total forecasted revenue for the generated advanced account forecast set records. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LastYearOrderQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The previous year order quantity for the generated advanced account forecast set records. ### LastYearOrderRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The previous year order revenue for the generated advanced account forecast set records. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the advanced account forecast fact. ### OpportunityQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The opportunity quantity for the generated advanced account forecast set records. ### OpportunityRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The opportunity revenue for the generated advanced account forecast set records. ### OrderQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The order quantity for the generated advanced account forecast set records. ### OrderRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The order revenue for the generated advanced account forecast set records. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this advanced account forecast fact. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The period for which the advanced account forecast records are generated. This is a relationship field. - **Relationship Name**: Period - **Relationship Type**: Lookup - **Refers To**: Period ### PeriodStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the period for which the advanced account forecast fact records are generated. Available in API version 54.0 and later. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product for which the advanced account forecast records are generated. This is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### SalesAgreementQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The Sales Agreement quantity for the generated advanced account forecast set records. ### SalesAgreementRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The Sales Agreement revenue for the generated advanced account forecast set records. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the forecast set associated with the advanced account forecast record. - **Default value**: Active - **Possible values**: - Active - Inactive # AdvAccountForecastPeriod Represents information about the periods for which advanced account forecasting is applied. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DisplayDuration - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The number of periods of the period group for which forecast is generated and displayed. ### ForecastPeriodGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The forecast period group associated with the forecast period. This is a relationship field. - **Relationship Name**: ForecastPeriodGroup - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastPeriodGroup ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The sequence number of the period in the associated advanced account forecast period group. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of the forecast period. - **Possible values**: - Month - Quarter - Year # AdvAccountForecastSet Represents a collection of fields to set up an advanced account forecast set. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AccountFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field name for the account in the advanced account forecast fact record. - **Possible values**: - AccountId—Advanced Account Forecast Fact:Account ID - AcctHierAAFChildAccount\_\_c—Advanced Account Forecast Fact:Child Account - AcctHierAAFParentAccount\_\_c—Advanced Account Forecast Fact:Parent Account - AdvAcctForecastSetPartnerId—Advanced Account Forecast Fact:Advanced Account Forecast Set Partner ID - AdvAcctForecastSetUseId—Advanced Account Forecast Fact:Advanced Account Forecast Set Use ID - CH\_ParentCategory\_\_c—Advanced Account Forecast Fact:Parent Category - CH\_ProductCategory\_\_c—Advanced Account Forecast Fact:Product Category - CreatedById—Advanced Account Forecast Fact:Created By ID - LastModifiedById—Advanced Account Forecast Fact:Last Modified By ID - ManufacturingProgramId—Manufacturing Program Variant Forecast Fact:Manufacturing Program ID - OwnerId—Advanced Account Forecast Fact:Owner ID - PeriodId—Advanced Account Forecast Fact:Period ID - ProductId—Advanced Account Forecast Fact:Product ID - UserRecordAccessId—Advanced Account Forecast Fact:Object Access Level ID ### CalculationFrequency - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency at which the forecast set is recalculated automatically. - **Default value**: Monthly - **Possible values**: - Monthly - Quarterly - Weekly - Yearly ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the advanced account forecast set record. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the advanced account forecast set record. ### ForecastFactObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The API Name of the object used to store the forecast facts. - **Possible values**: - AdvAccountForecastFact—Advanced Account Forecast Fact - MfgProgramCpntFrcstFact—Manufacturing Program Component Forecast Fact - MfgProgramForecastFact—Manufacturing Program Forecast Fact - MfgProgramVariantFrcstFact—Manufacturing Program Variant Forecast Fact ### ForecastPeriodGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast period group associated with the advanced account forecast set. This is a relationship field. - **Relationship Name**: ForecastPeriodGroup - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastPeriodGroup ### ForecastQuantityFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field name for the forecast quantity in the advanced account forecast fact record. - **Possible values**: - AcctHierAAFAdjustedAmount\_\_c—Advanced Account Forecast Fact:Adjusted Amount - AcctHierAAFAdjustedQuantity\_\_c—Advanced Account Forecast Fact:Adjusted Quantity - AcctHierAAFCountryManagerAmount\_\_c—Advanced Account Forecast Fact:Country Manager Amount - AcctHierAAFCountryManagerQuantity\_\_c—Advanced Account Forecast Fact:Country Manager Quantity - AcctHierAAFRegionalManagerAmount\_\_c—Advanced Account Forecast Fact:Regional Manager Amount - AcctHierAAFRegionalManagerQuantity\_\_c—Advanced Account Forecast Fact:Regional Manager Quantity - ActualGrossMarginPercent\_\_c—Advanced Account Forecast Fact:Actual Gross Margin Percent - ActualProfit\_\_c—Advanced Account Forecast Fact:Actual Profit - AdjustedForecastedQuantity—Manufacturing Program Variant Forecast Fact:Adjusted Forecasted Quantity - AdjustedForecastedRevenue—Manufacturing Program Forecast Fact:Adjusted Forecasted Revenue - CH\_AdjustedForecastedQuantity\_\_c—Advanced Account Forecast Fact:Adjusted Forecasted Quantity - CH\_AdjustedForecastedRevenue\_\_c—Advanced Account Forecast Fact:Adjusted Forecasted Revenue - CH\_SalesAgreementQuantityFromCategories\_\_c—Advanced Account Forecast Fact:Sales Agreement Quantity from Categories - CH\_SalesAgreementQuantityFromProducts\_\_c—Advanced Account Forecast Fact:Sales Agreement Quantity from Products - CH\_SalesAgreementRevenueFromCategories\_\_c—Advanced Account Forecast Fact:Sales Agreement Revenue from Categories - CH\_SalesAgreementRevenueFromProducts\_\_c—Advanced Account Forecast Fact:Sales Agreement Revenue from Products - CostPerUnit\_\_c—Advanced Account Forecast Fact:Cost Per Unit - ExpectedProfitPerUnit—Manufacturing Program Component Forecast Fact:Expected Profit Per Unit - ExpectedProfitPercent—Manufacturing Program Component Forecast Fact:Expected Profit Percent - ExpectedRevenuePerUnit—Manufacturing Program Forecast Fact:Expected Revenue Per Unit - FixedCost\_\_c—Advanced Account Forecast Fact:Fixed Cost - ForecastedGrossMarginPercent\_\_c—Advanced Account Forecast Fact:Forecasted Gross Margin Percent - ForecastedProfit\_\_c—Advanced Account Forecast Fact:Forecasted Profit - ForecastedQuantity—Manufacturing Program Variant Forecast Fact:Forecasted Quantity - ForecastedRevenue—Manufacturing Program Forecast Fact:Forecasted Revenue - LastYearOrderQuantity—Advanced Account Forecast Fact:Last Year Order Quantity - LastYearOrderRevenue—Advanced Account Forecast Fact:Last Year Order Revenue - MarketSharePercent—Manufacturing Program Variant Forecast Fact:Market Share Percent - OpportunityQuantity—Advanced Account Forecast Fact:Opportunity Quantity - OpportunityRevenue—Advanced Account Forecast Fact:Opportunity Revenue - OrderQuantity—Advanced Account Forecast Fact:Order Quantity - OrderRevenue—Advanced Account Forecast Fact:Order Revenue - PreviousPeriodProgramQuantity—Manufacturing Program Forecast Fact:Previous Period Program Quantity - ProgramQuantity—Manufacturing Program Forecast Fact:Program Quantity - SalesAgreementQuantity—Advanced Account Forecast Fact:Sales Agreement Quantity - SalesAgreementRevenue—Advanced Account Forecast Fact:Sales Agreement Revenue - SellingPricePerUnit—Manufacturing Program Component Forecast Fact:Selling Price Per Unit - TotalCostPerUnit—Manufacturing Program Component Forecast Fact:Total Cost - TotalCost\_\_c—Advanced Account Forecast Fact:Total Cost - TotalFixedCostPerUnit—Manufacturing Program Component Forecast Fact:Total Fixed Cost Per Unit - VariableCostPerUnit—Manufacturing Program Component Forecast Fact:Variable Cost Per Unit ### ForecastRevenueFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field name for the forecast revenue in the advanced account forecast record. - **Possible values**: - AcctHierAAFAdjustedAmount\_\_c—Advanced Account Forecast Fact:Adjusted Amount - AcctHierAAFAdjustedQuantity\_\_c—Advanced Account Forecast Fact:Adjusted Quantity - AcctHierAAFCountryManagerAmount\_\_c—Advanced Account Forecast Fact:Country Manager Amount - AcctHierAAFCountryManagerQuantity\_\_c—Advanced Account Forecast Fact:Country Manager Quantity - AcctHierAAFRegionalManagerAmount\_\_c—Advanced Account Forecast Fact:Regional Manager Amount - AcctHierAAFRegionalManagerQuantity\_\_c—Advanced Account Forecast Fact:Regional Manager Quantity - ActualGrossMarginPercent\_\_c—Advanced Account Forecast Fact:Actual Gross Margin Percent - ActualProfit\_\_c—Advanced Account Forecast Fact:Actual Profit - AdjustedForecastedQuantity—Manufacturing Program Variant Forecast Fact:Adjusted Forecasted Quantity - AdjustedForecastedRevenue—Manufacturing Program Forecast Fact:Adjusted Forecasted Revenue - CH\_AdjustedForecastedQuantity\_\_c—Advanced Account Forecast Fact:Adjusted Forecasted Quantity - CH\_AdjustedForecastedRevenue\_\_c—Advanced Account Forecast Fact:Adjusted Forecasted Revenue - CH\_SalesAgreementQuantityFromCategories\_\_c—Advanced Account Forecast Fact:Sales Agreement Quantity from Categories - CH\_SalesAgreementQuantityFromProducts\_\_c—Advanced Account Forecast Fact:Sales Agreement Quantity from Products - CH\_SalesAgreementRevenueFromCategories\_\_c—Advanced Account Forecast Fact:Sales Agreement Revenue from Categories - CH\_SalesAgreementRevenueFromProducts\_\_c—Advanced Account Forecast Fact:Sales Agreement Revenue from Products - CostPerUnit\_\_c—Advanced Account Forecast Fact:Cost Per Unit - ExpectedProfitPerUnit—Manufacturing Program Component Forecast Fact:Expected Profit Per Unit - ExpectedProfitPercent—Manufacturing Program Component Forecast Fact:Expected Profit Percent - ExpectedRevenuePerUnit—Manufacturing Program Forecast Fact:Expected Revenue Per Unit - FixedCost\_\_c—Advanced Account Forecast Fact:Fixed Cost - ForecastedGrossMarginPercent\_\_c—Advanced Account Forecast Fact:Forecasted Gross Margin Percent - ForecastedProfit\_\_c—Advanced Account Forecast Fact:Forecasted Profit - ForecastedQuantity—Manufacturing Program Variant Forecast Fact:Forecasted Quantity - ForecastedRevenue—Manufacturing Program Forecast Fact:Forecasted Revenue - LastYearOrderQuantity—Advanced Account Forecast Fact:Last Year Order Quantity - LastYearOrderRevenue—Advanced Account Forecast Fact:Last Year Order Revenue - MarketSharePercent—Manufacturing Program Variant Forecast Fact:Market Share Percent - OpportunityQuantity—Advanced Account Forecast Fact:Opportunity Quantity - OpportunityRevenue—Advanced Account Forecast Fact:Opportunity Revenue - OrderQuantity—Advanced Account Forecast Fact:Order Quantity - OrderRevenue—Advanced Account Forecast Fact:Order Revenue - PreviousPeriodProgramQuantity—Manufacturing Program Forecast Fact:Previous Period Program Quantity - ProgramQuantity—Manufacturing Program Forecast Fact:Program Quantity - SalesAgreementQuantity—Advanced Account Forecast Fact:Sales Agreement Quantity - SalesAgreementRevenue—Advanced Account Forecast Fact:Sales Agreement Revenue - SellingPricePerUnit—Manufacturing Program Component Forecast Fact:Selling Price Per Unit - TotalCostPerUnit—Manufacturing Program Component Forecast Fact:Total Cost - TotalCost\_\_c—Advanced Account Forecast Fact:Total Cost - TotalFixedCostPerUnit—Manufacturing Program Component Forecast Fact:Total Fixed Cost Per Unit - VariableCostPerUnit—Manufacturing Program Component Forecast Fact:Variable Cost Per Unit ### ForecastSetFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The name of the field used to store the forecast set and fact object relation. - **Possible values**: - AdvAcctForecastSetPartnerId—Advanced Account Forecast Fact:Advanced Account Forecast Set Partner ID - AdvAcctForecastSetUseId—Advanced Account Forecast Fact:Advanced Account Forecast Set Use ID - ManufacturingProgramId—Manufacturing Program Variant Forecast Fact:Manufacturing Program ID ### ForecastSetName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the forecast set. ### ForecastStatusFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field name for the Status in the advanced account forecast fact record. - **Possible values**: - CurrencyIsoCode—Manufacturing Program Variant Forecast Fact:Currency ISO Code - ExternalReferenceNumber—Manufacturing Program Variant Forecast Fact:External Reference Number - Name—Manufacturing Program Variant Forecast Fact:Manufacturing Program Variant Forecast Fact Name - Status—Manufacturing Program Variant Forecast Fact:Status ### GenerationDpeDefNameId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the Data Processing Engine definition used to generate advanced account forecast fact records. This is a relationship field. - **Relationship Name**: GenerationDpeDefName - **Relationship Type**: Lookup - **Refers To**: BatchCalcJobDefinition ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The combined language and locale ISO code, which controls the language of the advanced account forecast fact set record. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for this advanced account forecast set value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 58.0 and later. ### PeriodFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field name for the period in the advanced account forecast fact record. - **Possible values**: - PeriodId—Manufacturing Program Variant Forecast Fact:Period ID ### RecalculateDpeDefNameId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Data Processing Engine definition used to recalculate advanced account forecast fact records. This is a relationship field. - **Relationship Name**: RecalculateDpeDefName - **Relationship Type**: Lookup - **Refers To**: BatchCalcJobDefinition ### RegenerationDpeDefNameId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Data Processing Engine definition used to regenerate advanced account forecast fact records. This is a relationship field. - **Relationship Name**: RegenerationDpeDefName - **Relationship Type**: Lookup - **Refers To**: BatchCalcJobDefinition ### RolloverDpeDefNameId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Data Processing Engine definition used to generate rollover advanced account forecast fact records. This is a relationship field. - **Relationship Name**: RolloverDpeDefName - **Relationship Type**: Lookup - **Refers To**: BatchCalcJobDefinition ### RolloverFrequency - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency of rollover of the advanced account forecast records. - **Default value**: Monthly - **Possible values**: - Monthly - Quarterly - Weekly - Yearly ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the advanced account forecast set. - **Possible values**: - Active - Inactive # AdvAcctForecastAdjPeriod Represents details about the adjustment period of the advanced account forecast values. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdjustmentDayCount - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The number of days during which forecast adjustments can be made. ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The forecast set associated with the advanced account forecast adjustment period. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### Frequency - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates how frequently the adjustment windows will open. - **Possible values**: - Month - Quarter - Year ### ProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The profile with which the forecast set can be adjusted. This is a relationship field. - **Relationship Name**: Profile - **Relationship Type**: Lookup - **Refers To**: Profile ### StartDay - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The day when forecast adjustments can begin. # AdvAcctForecastDimension Represents information about the dimensions selected for an advanced account forecast set. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAcctForecastDimName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the dimension. ### AdvAcctForecastDimSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The dimension source associated with the advanced account forecast set dimension record. This is a relationship field. - **Relationship Name**: AdvAcctForecastDimSource - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastDimSource ### AdvAcctForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast set associated with the dimension. This is a relationship field. - **Relationship Name**: AdvAcctForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### DimensionFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The API name of the field for the dimension in the custom object that contains the generated advanced account forecast records. - **Possible values**: - AccountId—Advanced Account Forecast Fact:Account ID - Account\_\_c—AAFFact:Account - AdvAccountForecastSetId—Advanced Account Forecast Fact:Advanced Account Forecast Set ID - AdvAcctForecastSetPartnerId—Advanced Account Forecast Fact:Advanced Account Forecast Set Partner ID - Country\_\_c—Advanced Account Forecast Fact:Country - CreatedById—Advanced Account Forecast Fact:Created By ID - CurrencyIsoCode—Advanced Account Forecast Fact:Currency ISO Code - LastModifiedById—Advanced Account Forecast Fact:Last Modified By ID - Name—Advanced Account Forecast Fact:Name - OwnerId—Advanced Account Forecast Fact:Owner ID - PeriodId—Advanced Account Forecast Fact:Period ID - ProductId—Advanced Account Forecast Fact:Product ID - Region\_\_c—Advanced Account Forecast Fact:Region - UserRecordAccessId—Advanced Account Forecast Fact:Object Access Level ID ### HierarchySequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The display sequence of the dimension in the forecast data grid. # AdvAcctForecastDimSource Represents information about the dimensions that can be used by advanced account forecast sets to generate advanced account forecast records. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAcctForecastDimSrcName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the dimension source. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 consecutive underscores In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Available in API version 54.0 and later. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The combined language and locale ISO code, which controls the language of the advanced account forecast dimension source record. Available in API version 54.0 and later. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for this advanced account forecast dimension source record value. This display value is the internal label that doesn't get translated. Available in API version 54.0 and later. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 58.0 and later. ### SourceObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The API name of the object that's used as a dimension to generate the advanced account forecast records. # AdvAcctForecastFactAdj Represents information about adjustments made to advanced account forecast fact records. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AdjustedById - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the user who’s made an adjustment to the advanced account forecast fact record. This is a relationship field. - **Relationship Name**: AdjustedBy - **Relationship Type**: Lookup - **Refers To**: User ### AdvAcctForecastFactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The advanced account forecast fact record to which an adjustment was made. This is a polymorphic relationship field. - **Relationship Name**: AdvAcctForecastFact - **Relationship Type**: Lookup - **Refers To**: AAFFact\_\_c, AdvAccountForecastFact, Country\_\_c, Region\_\_c, lookup\_to\_rebate\_product\_\_c, testRebate\_\_c ### AdvAcctForecastMeasureDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast set measure definition of the forecast fact record to which the adjustment is being made. This is a relationship field. - **Relationship Name**: AdvAcctForecastMeasureDef - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastMeasureDef ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information related to the adjustment of the forecast data. ### InitialValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecast value in the forecast fact record before the adjustment is made. ### UpdatedValue - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The forecast value in the forecast fact record after the adjustment is made. # AdvAcctForecastMeasureDef Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast set associated with the advanced account forecast metric. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### AdvAcctForecastMeasureDefName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name for the measure. ### AggregationType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of aggregation used for calculating advanced account forecast values. - **Default value**: SUM - **Possible values**: - AVERAGE—Average - MAXIMUM—Maximum - MINIMUM—Minimum - SUM—Sum ### ComputationMethod - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The method used for calculating advanced account forecast values. - **Default value**: Batch Process - **Possible values**: - CUSTOM—User-Editable - DATA\_PROCESSING\_ENGINE\_DEFINITION—Batch Process - FORMULA—Forecast Formula ### ForecastDataMeasureName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Field of the facts object used for this measure. ### ForecastMeasureName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name for the measure to show on UI. ### ForecastMeasureType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the measure type used for the generated advanced forecast values. - **Default value**: QUANTITY - **Possible values**: - QUANTITY—Quantity - REVENUE—Revenue ### IsAdjustmentTracked - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked. - **Default value**: false # AdvAcctForecastPeriodGroup Represents information about advanced account forecast period records. This is the parent object of all the related advanced account forecast period records. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can’t include spaces - can’t end with an underscore - can’t contain 2 consecutive underscoresIn managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. ### ForecastPeriodGroupName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the advanced account forecast period group record. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The combined language and locale ISO code, which controls the language of the advanced account forecast period group record. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for this advanced account forecast period group value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. Available in API version 58.0 and later. ### StartPeriod - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The start period of the advanced account forecast period group. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the advanced account forecast period group. - **Default value**: Active - **Possible values**: - Active - Inactive # AdvAcctForecastSetPartner Represents a junction between an advanced account forecast set and an account. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account that uses the forecast set for generating advanced account forecast records. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast set associated with the account. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The reference number of the account forecast set partner record used to associate it with the account forecast fact records. ### LastCalculationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the advanced account forecast values were last calculated for the associated account and forecast set. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the advanced account forecast set partner record. If a partner record is inactive, you can’t edit the corresponding forecast fact records. - **Default value**: Active - **Possible values**: - Active - Draft - Inactive # AdvAcctForecastSetUse Represents a junction between an advanced account forecast set and another object whose record serves as the context for generating forecasts. For example, a manufacturing program or a Sustainability Cloud object’s record can be the context for generating forecasts. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The forecast set associated with the account. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The reference number of the manufacturing program record used to associate it with the account forecast fact records. ### ForecastContextId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The object whose record is used as the context for generating forecasts. This is a polymorphic relationship field. - **Relationship Name**: ForecastContext - **Relationship Type**: Lookup - **Refers To**: Account, ManufacturingProgram ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the advanced account forecast use record. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the advanced account forecast set partner record. - **Default value**: Active - **Possible values**: - Active - Approved - Canceled - Draft - Inactive - Rejected - SubmittedForApproval—Submitted For Approval # AdvAcctFrcstDisplayGroup Represents information about the groups for the advanced account forecast set measures or dimensions. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The forecast set associated with the advanced account forecast display group. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### AdvAcctFrcstDisplayGroupName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the advanced account forecast display group. ### GroupType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the category for the display group. - **Possible values**: - MEASURE—Measure ### IsDefault - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the display group is the default group. - **Default value**: false ### UserProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The profile for which the display group is applicable. This is a relationship field. - **Relationship Name**: UserProfile - **Relationship Type**: Lookup - **Refers To**: Profile # AdvAcctFrcstDplyGroupItem Represents information about the items associated with a display group for an advanced account forecast set. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAcctFrcstDisplayGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The advanced account forecast display group that’s associated with the group item. This is a relationship field. - **Relationship Name**: AdvAcctFrcstDisplayGroup - **Relationship Type**: Lookup - **Refers To**: AdvAcctFrcstDisplayGroup ### AdvAcctFrcstDplyGroupItemName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the advanced account forecast display group item. ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The display order of the display group item. ### MeasureReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the measure associated with the display group item. This is a relationship field. - **Relationship Name**: MeasureReference - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastMeasureDef # Advanced Orders for Telesales in Manufacturing Cloud Build and place telesales orders based on product assortments, the product catalog, and previously ordered products, with valid delivery dates and instant pricing for order line items. For more information about Advanced Orders for Telesales, see the [Advanced Orders for Telesales Developer Guide](https://developer.salesforce.com/docs/industries/advanced-orders-for-telesales/overview). # API End-of-Life Policy Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality and performance of the API, versions that are over 3 years old sometimes are no longer supported. Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends. # AssetAccountParticipant Represents a junction between the Asset and Account objects describing the association between a participating account and an asset. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The stakeholder account associated with the asset. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the account. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Master-detail - **Refers To**: Asset (the master object) ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the association between the stakeholder and the asset ended. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the association between the stakeholder and the asset was initiated. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the association between the stakeholder and the asset is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset account participant. ### StakeholderRole - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the role of the associated account. - **Possible values**: - Customer ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset account participant. - **Possible values**: - Manufacturing # AssetContactParticipant Represents a junction between the Asset and Contact objects describing the association between a participating contact and an asset. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset associated with the contact. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The contact associated with the asset. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the association between the stakeholder and the asset ended. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the association between the stakeholder and the asset was initiated. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the association between the stakeholder and the asset is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset contact participant. ### StakeholderRole - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the role of the associated contact. - **Possible values**: - Service Manager ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset contact participant. - **Possible values**: - Manufacturing # AssetMilestone Represents the key events in the lifecycle of an asset, such as manufacturing, registration, or resale. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address associated with the milestone. ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset record that's associated with the milestone. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Master-detail - **Refers To**: Asset (the master object) ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the milestone occurred. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the milestone occurred. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the milestone. ### ExpiredDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expiration date of the milestone. ### GeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the milestone location’s latitude and longitude coordinates. - **Possible values**: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location associated with the milestone. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the milestone location. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### MilestoneDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the milestone occurred. ### MilestoneType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of milestone. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the asset milestone. ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the location where the milestone occurred. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the milestone in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system from where the record was imported. ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the stage of the milestone. - **Possible values**: - Active - Expired - Tentative ### StageComment - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments about the stage of the milestone. For example, the reason for marking the milestone as tentative. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the milestone occurred. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street where the milestone occurred. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the asset milestone. - **Possible values**: - Manufacturing # AssetWarranty Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in Manufacturing Cloud in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the asset this asset warranty applies to. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetWarrantyNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The identifier of the asset warranty record. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this asset warranty expires. ### ExchangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of exchange offered by this asset warranty. - **Possible values**: - Advance Exchange - Loaner - Return Exchange ### Exclusions - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of any exclusions. ### ExpensesCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of expenses covered. ### ExpensesCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for expenses ends. ### IsTransferable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset warranty can be transferred to a new owner (true) or not (false). - **Default value**: false ### LaborCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of labor covered. ### LaborCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for labor ends. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the asset warranty was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the asset warranty was last viewed. ### PartsCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of parts covered. ### PartsCoveredEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which cover for parts ends. ### Pricebook2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The price book item associated with this asset warranty term. This field is a relationship field. - **Relationship Name**: Pricebook2 - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which cover under this asset warranty starts. ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the warranty term this asset warranty term extends. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm ### WarrantyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the asset warranty. - **Possible values**: - Repair - Standard - Supplier # Calculate Advanced Account Forecasts Action Calculate forecasts for an account based on the formulae associated with the forecast set. For more information about calculating forecasts for an account, see [Use Manufacturing Actions in Flow Builder and Process Builder](https://help.salesforce.com/s/articleView?id=ind.admin_manufacturing_standard_invocable_actions.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This object is available in API version 52.0 and later. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/calculateAdvancedAccountForecast **Formats:** JSON **HTTP Methods:** GET, POST **Authentication:** Authorization: Bearer token ## Inputs | Input | Type | Description | | --- | --- | --- | | accountId | array | The ID of the account record for which to calculate the forecasts. | | forecastDataId | array | The ID of the forecast data for which the forecast is being calculated. | | forecastSetId | array | The ID of the forecast set associated with the forecast formulae to be used for calculation. | ## Usage **JSON Sample Request** { "inputs":\[{ "forecastSetId":"0ni5sajb8347k3s", "accountId": "0yAxx00004000002AAA", "forecastDataId": "0r4ft8941574TRE78V" }\] } **JSON Sample Response** \[ { "errors":null, "isSuccess":true } \] # Claim Represents a warranty Claim submitted by a partner to a manufacturer, or a supplier recovery claim submitted by the manufacturer to a supplier. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the account related to the claim. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ClaimReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for initiating the claim. ### ClaimReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category to which the claim reason belongs. - **Possible values**: - Accident - Natural Disaster ### ClaimType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the claim. - **Default value**: Warranty Claim - **Possible values**: - Pre Warranty Authorization - Warranty Claim ### ClaimTypeCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the claim. - **Default value**: Warranty Claim - **Possible values**: - PreWarrantyAuthorization - SupplierRecoveryClaim - WarrantyClaim ### FinalizedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the claim was marked resolved, with claim status as approved or rejected. ### FnolChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel through which the loss was reported. - **Possible values**: - Chatbot - Mobile - Phone - Web ### IsClosed - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the claim has been closed (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The claim number in the claims management system. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RelatedClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the claim related to this claim. This field is a relationship field. - **Relationship Name**: RelatedClaim - **Relationship Type**: Lookup - **Refers To**: Claim ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The severity of the claim. - **Possible values**: - High - Low - Medium ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the claim. - **Default value**: Draft - **Possible values**: - Approved - Draft - Manual Review Needed - Rejected - Requested Information - Submitted - Under Review ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the claim. ### TotalAdjustedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The claim amount that was approved. This field is a calculated field. ### TotalClaimedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount being claimed. This field is a calculated field. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The usage type of the Claims record. - **Possible values**: - Manufacturing # ClaimCoverage Represents a causal part in a defective asset that requires repair or replacement. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetWarrantyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset warranty ID of the defective asset in the associated claim item. This field is a relationship field. - **Relationship Name**: AssetWarranty - **Relationship Type**: Lookup - **Refers To**: AssetWarranty ### CausalPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product part that causes the issues related to the claim. This field is a relationship field. - **Relationship Name**: CausalPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim record associated with this claim coverage. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### ClaimItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the claim item record associated with the claim coverage. This field is a relationship field. - **Relationship Name**: ClaimItem - **Relationship Type**: Lookup - **Refers To**: ClaimItem ### ClaimParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the claim participant record associated with this claim coverage. This field is a relationship field. - **Relationship Name**: ClaimParticipant - **Relationship Type**: Lookup - **Refers To**: ClaimParticipant ### CoverageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of claim coverage. - **Possible values**: - Extended Warranty - None - Standard Warranty ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the coverage for the claim. ### ExtlWorkOrderReference - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external identifier of the work order. ### FaultCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code ID that uniquely identifies the fault caused by the part. This field is a relationship field. - **Relationship Name**: FaultCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the claim coverage. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductRelatedMaterialId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the Product Related Material record that defines the association between the causal part and the product associated with the claim. This field is a relationship field. - **Relationship Name**: ProductRelatedMaterial - **Relationship Type**: Lookup - **Refers To**: ProductRelatedMaterial ### RelatedClaimCoverageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The claim coverage against which the supplier recovery claim is created. This field is a relationship field. - **Relationship Name**: RelatedClaimCoverage - **Relationship Type**: Lookup - **Refers To**: ClaimCoverage ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a claim coverage. - **Possible values**: - Approved - Closed - Open - Rejected ### TotalAdjustedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount that's adjusted in a claim. This field is a calculated field. ### TotalClaimedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total amount being claimed. This field is a calculated field. # ClaimCoveragePaymentDetail Represents the claim coverage amount that must be paid to a claimant for a part replaced or replaced or a labor service performed to rectify a causal part in a defective asset. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualExpense - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual expense of the part replacement or labor service. ### AdjustedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the manufacturer intends to pay to the claimant for the repair, replacement, or labor service to rectify a causal part. ### ChargeType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of charge. - **Default value**: Replaced Part - **Possible values**: - Labor - Other - Replaced Part ### ChargeTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code that identifies the labor charge or expense. This field is a relationship field. - **Relationship Name**: ChargeTypeCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ClaimCoverageId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim coverage record associated with the Claim Coverage Payment Detail. This field is a relationship field. - **Relationship Name**: ClaimCoverage - **Relationship Type**: Lookup - **Refers To**: ClaimCoverage ### ClaimedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount claimed by the claimant as a part of the claim coverage payment detail. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comments made by the warranty claims adjudicator while adjudicating the claim coverage payment detail. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the claim coverage payment detail. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the claim coverage payment detail. ### PriceBookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The entry of the product related to the replacement part in the price book. This field is a relationship field. - **Relationship Name**: PriceBookEntry - **Relationship Type**: Lookup - **Refers To**: PricebookEntry ### ProductRelatedMaterialId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product related material record that defines the association between the replacement part and the product associated with the claim. This field is a relationship field. - **Relationship Name**: ProductRelatedMaterial - **Relationship Type**: Lookup - **Refers To**: ProductRelatedMaterial ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of parts replaced or the number of labor hours. ### ReplacementPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product part that's a replacement for the defective part. This field is a relationship field. - **Relationship Name**: ReplacementPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### ReturnOrderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the return order related to the claim coverage payment detail. This field is a relationship field. - **Relationship Name**: ReturnOrder - **Relationship Type**: Lookup - **Refers To**: ReturnOrder ### ReturnOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the return order line item related to the claim coverage payment detail. This field is a relationship field. - **Relationship Name**: ReturnOrderLineItem - **Relationship Type**: Lookup - **Refers To**: ReturnOrderLineItem ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of claim coverage payment detail. - **Possible values**: - Approved - None - Rejected # ClaimItem Represents a defective asset that requires repair or replacement. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset associated with the claim. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetUsageUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit of measure for the usage value of the asset. - **Possible values**: - Hours - Miles ### AssetUsageValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The usage value for the asset at the time of occurrence of the fault. ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The parent claim that includes this claim item. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### FaultDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of occurrence of the fault in the asset. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the claim item. ### RepairDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of repair of the asset. # ClaimParticipant A junction object that associates the Claim object with the Account object. This object represents the participants of a claim. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ClaimId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the claim in which this participant has one or more roles. This field is a relationship field. - **Relationship Name**: Claim - **Relationship Type**: Lookup - **Refers To**: Claim ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Auto-generated number for the name of the claim participant record. ### Roles - **Type**: multipicklist - **Properties**: Create, Filter, Update - **Description**: The roles that the claim participant can have in the claim. - **Possible values**: - Claimant # CodeSet Represents various industry defined codes in the context of their systems and versions of those systems. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that’s represented by this code set. ### CodeDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information associated with the code set. ### CodeSetKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key that identifies the concept represented by code sets across different systems and versions. This key is not case sensitive. ### CodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the code set. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the code set’s effective period. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is an active code set (true) or not (false). - **Default value**: false ### IsCustomCode - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is defined by a specific organization, as opposed to recognized across the industry. - **Default value**: false ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is the primary code set for the concept (true) or not (false). That is, it was selected manually by a user instead of being selected by an automated process. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The textual representation of the meaning of the code. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: A reference to the person who owns the code set record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system that sets the context for the code and defines its meaning. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the code set’s effective period. ### SystemVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the source system the code belongs to. # CodesetRelationship Represents a relationship between a codeset and its related codeset. For example, a labor code associated with a fault code. This object is available in Manufacturing Cloud in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The codeset that's associated with another related codeset. This field is a relationship field. - **Relationship Name**: CodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet ### CodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the codeset. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated name of the codeset relationship. ### RelatedCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related codeset that's associated with the codeset. This field is a relationship field. - **Relationship Name**: RelatedCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet ### RelatedCodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the related codeset. # DealerProdtSearchableField Represents information about dealers selling and, or, servicing products for location-based searches. Helps customers find nearby dealer locations for product purchases and services. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()getDeleted() search()getUpdated() ## Fields ### AvailabilityDate - **Type**: datetime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the part is made available for sale or used in the product. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business brand related to a vehicle model. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### BusinessBrandName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business brand. ### BusinessPartnerType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of dealer that’s associated with a vehicle or its parts. ### BusinessProfile - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business profile related to a dealer's account. This field is a relationship field. - **Relationship Name**: BusinessProfile - **Refers To**: BusinessProfile ### DealerAccount - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account related to a dealer's business profile. This field is a relationship field. - **Relationship Name**: DealerAccount - **Refers To**: Account ### DealerLocation - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The location of the dealer. ### DealerName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the dealer. ### DealerPhone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The phone number of the dealer. ### DealerRating - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The rating of the dealer. ### DealerWebsite - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The website of the dealer. ### DiscontinuedDate - **Type**: datetime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: TThe date from when the part can no longer be used or sold. ### HarmonizedSystemCode - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code assigned to the product or a part used in the product for international trade. ### HarmonizedTariffSchedCode - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The tariff schedule code assigned to the product or part for customs classification. ### Industry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The industry of the dealer. ### IsCertified - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the accessory part installed in the product is certified. ### IsEnvrPrtcRegCompliant - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the product is compliant with environment protection regulations. ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The make name of a vehicle. ### ManufacturerName - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturer name for the part used in the product. ### ManufacturerPartNumber - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique number assigned by the manufacturer to identify the part. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of a vehicle. ### ModelYear - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model year of a vehicle. ### ModelYearVersion - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The specific iteration of a product introduced (e.g., 2021.5, 2021.75). ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### ProductFamily - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code of a product related to a vehicle model. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product related to a seller product. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductLineCode - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product category or line associated with the specific part. ### ProductCategoryCode - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The part category code associated with the product. ### ProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the product related to a vehicle model. ### RegionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the region where the dealer operates from. ### SellerProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The seller product related to a product. This field is a relationship field. - **Relationship Name**: SellerProduct - **Refers To**: SellerProduct ### SellerRole - **Type**: text - **Properties**: Create, Update - **Description**: The role of the seller related to the product, such as for sales or for service. ### ServiceTerritoryAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address of the service territory related to a dealer's business profile. ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory related to a dealer's business profile. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Refers To**: ServiceTerritory ### ServiceTerritoryName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the service territory related to a dealer's business profile. ### TrimType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The trim type of the vehicle model, such as DX, GT, or LS. ### UniversalProductCode - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The universal product code (UPC/Barcode) used to track the part. # EngagementAttendee Represents information about an attendee of an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, this object stores information about the customer and the service representative. This object is available in API version 55.0 and later ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Manufacturing Cloud permission set license is required to use this object. ## Fields ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the engagement with the attendee ends. ### EngagementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The engagement interaction, messaging session, or voice call that’s related to the attendee. This field is a relationship field. - **Relationship Name**: Engagement - **Relationship Type**: Lookup - **Refers To**: EngagementInteraction, MessagingSession, VoiceCall ### ExternalAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external user related to the engagement, such as the customer or partner. To avoid an error, either this field or the InternalAttendeeId field must have a value. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: ExternalAttendee - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### InternalAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The internal user related to the engagement, such as the call center agent. To avoid an error, either this field or the ExternalAttendeeId field must have a value. This field is a relationship field. - **Relationship Name**: InternalAttendee - **Relationship Type**: Lookup - **Refers To**: User ### IsAuthenticated - **Type**: boolean - **Properties**: Create, Defaulted on Create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction was authenticated through interactive voice response (IVR) or Web channel (true) or not (false). This field is available in API version 56.0 and later. - **Default value**: false ### IsVerified - **Type**: boolean - **Properties**: Create, Defaulted on Create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction was verified (true) or not (false). This field is available in API version 56.0 and later. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Engagement Attendee record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement attendee record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of an engagement attendee. This field is available in API version 56.0 and later. - **Possible values**: - OnBehalf - Self ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Required. The date and time when the engagement with the attendee starts. ### VerificationTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the attendee was verified for the engagement interaction. This field is available in API version 56.0 and later. ## Usage ### Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[EngagementAttendeeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[EngagementAttendeeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[EngagementAttendeeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # EngagementInteraction Represents information about an interaction between a service representative or any other specialist in an organization and the organization’s customer. Engagement interactions can be initiated through communication channels and can cover one or more topics. For example, a customer can initiate an engagement interaction by calling a service representative to inquire about an insurance claim. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Manufacturing Cloud permission set license is required to use this object. ## Fields ### AttendeeVerificationTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the attendee was verified for the engagement interaction. You can manually set this time. If isAttendeeVerified is set to true, then if you don’t manually set this time, it’s set based on the current system date and time. ### CommunicationChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Required. The communication channel through which engagement interaction occurs. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - In Person - Video Call - Voice Call - Web Chat ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record that’s considered as the context for the engagement interaction. For example, when a customer initiates an engagement interaction by booking a service appointment for an inquiry, the service appointment is the context for that engagement interaction. This field is a polymorphic relationship field. A polymorphic field is one where the related object can be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: Context - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment, Visit ### Duration - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Read-only. The duration of the engagement interaction based on the start date time and end date time. The duration is calculated when the end time is updated. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the engagement interaction ends. ### ExternalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique external identifier of the engagement interaction. ### InitiatingAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The attendee who initiated the engagement interaction. This field is a polymorphic relationship field. A polymorphic field is one where the related object can be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: InitiatingAttendee - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### IsAttendeeAuthenticated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction has been authenticated through IVR or Web channel (true) or not (false). - **Default value**: false ### IsAttendeeVerified - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction has been verified (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. ### MappedState - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the state of the engagement interaction that changes when the status of the interaction gets updated. - **Default value**: New - **Possible values**: - Completed - InProgress - New ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Engagement Interaction record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement interaction record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### PhoneNumber - **Type**: phone - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The phone number of the caller to get the context about the previous engagement interaction. This field is available in API version 57.0 and later. ### Reason - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reason for the engagement as stated by the customer or their representative during the engagement interaction. This field is available from API version 56.0 and later. ### Sentiment - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The analyzed sentiment of the engagement interaction attendee about the engagement interaction. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Negative - Neutral - Positive ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Required. The date and time when the engagement interaction starts. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the engagement interaction, which also impacts the interaction state. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Completed - In Progress - New ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of interaction that was initiated by the attendee. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Inbound - Outbound ## Usage ### Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[EngagementInteractionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[EngagementInteractionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[EngagementInteractionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # EngagementTopic Represents information about the topics discussed by a customer and other attendees during an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, the topic of the engagement is Claim. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Manufacturing Cloud permission set license is required to use this object. ## Fields ### EngagementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The engagement interaction, messaging session, or voice call record that’s related to the topic discussed during the engagement. This field is a relationship field. - **Relationship Name**: Engagement - **Relationship Type**: Lookup - **Refers To**: EngagementInteraction, MessagingSession, VoiceCall ### InteractionSummary - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The summary of the engagement interaction. This field is available in API version 56.0 and later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the engagement topic record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement topic record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### ParentTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent engagement topic record that’s associated with this engagement topic. This field is a relationship field. - **Relationship Name**: ParentTopic - **Relationship Type**: Lookup - **Refers To**: EngagementTopic ### ProcessFailureReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the reason the process failed during the engagement interaction. The source is selected from a picklist of available values, which are set by your Salesforce administrator. ### ProcessName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the process executed during the engagement interaction. ### ProcessStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the process that’s executed during the engagement interaction. Your Salesforce administrator can define new or update the existing field values. - **Possible values**: - Cancelled - Completed - Failed - Initiated ### ProcessType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the process executed during the engagement interaction. - **Possible values**: - Flow - OmniScript - QuickAction ### RelatedPersonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person for whom the engagement interaction has been initiated. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: RelatedPerson - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### TopicId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engagement topic record that’s associated with the parent engagement topic. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: Topic - **Relationship Type**: Lookup - **Refers To**: Asset, Case, Claim, LoyaltyMemberTier, LoyaltyProgramMember, Opportunity, Order, ServiceAppointment, Voucher, TransactionJournal, and custom object ## Usage ### Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[EngagementTopicChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[EngagementTopicFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[EngagementTopicHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # Fleet Represents a group of assets used in commercial, service, or transport operations in the manufacturing industry. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActiveAssetCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The total number of assets associated with a fleet record. This field shows a rolled-up value based on the number of Fleet Asset records in Active status associated with a Fleet record. This field is a calculated field. ### CurrentOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current owner of the fleet. This field is a relationship field. - **Relationship Name**: CurrentOwner - **Relationship Type**: Lookup - **Refers To**: Account ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when a fleet is operational. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when a fleet is operational. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the location that the fleet is associated with. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of a fleet record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user or user group who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentFleetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent fleet that a fleet record is part of in a hierarchy. This field is a relationship field. - **Relationship Name**: ParentFleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of a fleet record. - **Default value**: Active - **Possible values**: - Active - Inactive ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of a fleet record. - **Possible values**: - Commercial - Employee - Executive - Material # FleetAsset Represents the relationship between an asset and the fleet to which it belongs. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Asset associated with the Fleet Asset record. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### AssetUsage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total usage of an asset such as the number of hours for which a machine runs. ### AssetUsageUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the total usage of an asset. This field is a relationship field. - **Relationship Name**: AssetUsageUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when an asset is part of the fleet. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date from when an asset is part of the fleet. ### FleetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fleet associated with the Fleet Asset record. This field is a relationship field. - **Relationship Name**: Fleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of a Fleet Asset record. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the asset in the associated fleet. - **Possible values**: - Active - Assigned - Inactive - Out of Service - Registered - Under Maintenance # FleetParticipant Represents the relationship between a fleet and a participant, such as an account, a contact, or a user. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when a participant is associated with a fleet. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when a participant is associated with a fleet. ### FleetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fleet associated with the Fleet Participant record. This field is a relationship field. - **Relationship Name**: Fleet - **Relationship Type**: Lookup - **Refers To**: Fleet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autopopulated name of a Fleet Participant record. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The participant associated with a Fleet, such as an account, a user, or a contact. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Relationship Type**: Lookup - **Refers To**: Account, Contact, User ### ParticipantRole - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The role of a participant associated with a fleet. - **Possible values**: - Driver - Maintenance Associate - Manager - Operations Manager ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the participant in relation to a fleet. - **Possible values**: - Active - Inactive - Resigned # Flow for Manufacturing Cloud Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Manufacturing Cloud exposes additional actionType values for the FlowActionCall Metadata type. For more information on Flow and FlowActionCall Metadata Type, see [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm). ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Manufacturing Cloud include: - calculateAdvancedAccountForecast—Calculate forecasts for an account based on the formulae associated with the forecast set. - getSalesAgreementDetails—Retrieves a comprehensive collection of all required data (spread across multiple entities like SalesAgreement, Product2, SalesAgreementProduct, etc.) for a given Sales Agreement. Available in API version 61.0 and later. - getSearchConfigurationMetadata—Retrieves all metadata details and search configurations for a given searchable object. Available in API version 64.0 and later. - importRecordsFromCsvFile—Imports and converts data from a CSV file into target object records. Available in API version 55.0 and later. - massUpdateAccountForecast—Mass updates account forecast fields for different products and periods with this single action. Available in API version 48.0 and later. - massUpdateAdvAccountForecast—Update a measure of AdvAccountForecastFact records based on filter condition of the selected list view. Available in API version 56.0 and later. - massUpdateSalesAgreement—Mass updates sales agreement fields for different products and periods with this single action. Available in API version 48.0 and later. - recalculateForecast—Recalculates forecasts based on orders, opportunity, and sales agreement figures. Available in API version 47.0 and later. - refreshActualsCalculation—Refreshes actuals calculations for sales agreements for current and future periods. Available in API version 47.0 and later. - replenishInventoryUsingPolicy—Executes inventory policy to identify stock shortages, determine the optimal source location, and automate replenishment. Available in API version 65.0 and later. - transformMfgProgramForecasts—Submits a message to a queue service to asynchronously process and transform manufacturing program forecasts. Available in API version 64.0 and later. - updateAcctMgrTarget—Updates an account manager target’s assignment values when the target’s value changes. Available in API version 49.0 and later. - updateAdvancedAccountForecastSetPartner—Updates the status of the Advanced Account Forecast Set Partner record after the forecast data for a given combination of account and forecast sets has been generated. # GenericVisitTask Represents information about a task that can be performed during a visit. This object is available in Manufacturing Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GenericVisitTask ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the task. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the visit task. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition record. - **Default value**: false ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a task must be completed to complete a visit. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the generic visit task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the generic visit task record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Sequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the visit task can be performed. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the visit task. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of the generic visit task. - **Default value**: Is Defined - **Possible values**: - Completed - In Progress - Is Defined - Not Started ### StatusCode - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the status code of the generic visit task. - **Default value**: IsDefined - **Possible values**: - Completed - InProgress— In Progress - IsDefined— Is Defined - NotStarted— Not Started ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with the record. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Lookup - **Refers To**: Visit ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GenericVisitTaskChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[GenericVisitTaskFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[GenericVisitTaskHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. **[GenericVisitTaskOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm):** Sharing rules are available for the object. **[GenericVisitTaskShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm):** Sharing is available for the object. # GenericVisitTaskContext Represents the context or purpose for a generic visit task. This object is available in Manufacturing Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record that’s taken as the context for the visit task. For example, if a key performance indicator is recorded for a warranty of an asset, the Asset and the Warranty records are the contexts of the visit task. This field is a polymorphic relationship field. - **Relationship Name**: Context - **Relationship Type**: Lookup - **Refers To**: Account, Account\_\_c, AcctMgrTarget, AdvAccountForecastFact, AdvAcctForecastSetPartner, AdvAcctForecastSetUse, Assessment, AssessmentIndicatorDefinition, AssessmentQuestion, AssessmentQuestionAssignment, AssessmentQuestionResponse, AssessmentQuestionSet, AssessmentQuestionVersion, AssessmentTask, AssessmentTaskContentDocument, AssessmentTaskDefinition, Asset, AssetAccountParticipant, AssetContactParticipant, AssetMilestone, AssetRelationship, AssetWarranty, BusinessMilestone, BusinessProfile, Case, CommSubscriptionConsent, Contact, ContactRequest, Contract, EngagementAttendee, EngagementInteraction, EngagementTopic, GenericVisitTask, GenericVisitTaskContext, GnrcVstKeyPerformanceInd, GnrcVstTaskContextRelation, Image, InfoAuthorizationRequest, Lead, LeadLineItem, LeadPreferredSeller, ListEmail, Location, ManufacturingProgram, MfgProgramCpntFrcstFact, MfgProgramForecastFact, MfgProgramVariantFrcstFact, MultipartyInfoAuthRequest, OmniProcessAsmtQuestionVer, Opportunity, OpportunityPreferredSeller, Order, Organization, PartyConsent, PartyRelationshipGroup, PersonLifeEvent, PgmRebateTypBnftMapping, ProcessException, Product2, ProductCatalog, ProductCategory, ProductItem, ProductRelatedMaterial, ProductRequest, ProductRequestLineItem, ProductTransfer, ProgramRebateTypPayoutSrc, ProgramRebateType, ProgramRebateTypeBenefit, ProgramRebateTypeFilter, ProgramRebateTypePayout, ProgramRebateTypeProduct, ProgramRebateTypeReference, PurchaseQuantityRule, RebateClaim, RebateMemberAggregateItem, RebateMemberProductAggregate, RebatePayment, RebatePayoutAdjustment, RebateProgram, RebateProgramMember, RebateProgramMemberPayout, RebateProgramPayoutPeriod, ReceivedDocument, RecordAlert, SalesAgreement, ServiceAppointment, ServiceResource, Shipment, ShipmentItem, Solution, Supplier, TagCategory, UnitOfMeasureConversion, Vehicle, VehicleDefinition, Visit, VisitedParty, WarrantyTerm, WorkOrder, WorkOrderLineItem ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the visit task context. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the visit task context in a visit. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition record. - **Default value**: false ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the visit task context associated with the record is mandatory. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Autogenerated unique identifier for the visit task context record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the visit task context record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the visit task context in a visit. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the status of the visit task context. - **Default value**: Is Defined - **Possible values**: - Completed - In Progress - Is Defined - Not Started ### StatusCode - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the status code of the visit task context. - **Default value**: IsDefined - **Possible values**: - Completed - InProgress—In Progress - IsDefined—Is Defined - NotStarted—Not Started ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with the record. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Lookup - **Refers To**: Visit ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GenericVisitTaskContextChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[GenericVisitTaskContextFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[GenericVisitTaskContextHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. **[GenericVisitTaskContextOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm):** Sharing rules are available for the object. **[GenericVisitTaskContextShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm):** Sharing is available for the object. # Get Inventory Allocation Instance Reservation Instance-level reservation for a serialized product not in a batch. ## JSON Example { "instanceReservationId": "instRes123", "itemInstanceId": "serial123", "itemInstanceType": "SerializedProduct", "serialNumber": "SN-12345", "status": "Allocated", "reservationDate": "2025-02-08T10:00:00Z", "isAutoReserved": false } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | instanceReservationId | String | Unique identifier for the instance reservation. | Big, 67.0 | 67.0 | | isAutoReserved | Boolean | Whether the reservation was created automatically. | Big, 67.0 | 67.0 | | itemInstanceId | String | Id of the item instance (e.g. serialized product instance). | Big, 67.0 | 67.0 | | itemInstanceType | String | Type of the item instance (e.g. SerializedProduct). | Big, 67.0 | 67.0 | | reservationDate | String | When the reservation was created. | Big, 67.0 | 67.0 | | serialNumber | String | Serial number of the serialized product. | Big, 67.0 | 67.0 | | status | String | Reservation status (e.g. Allocated). | Big, 67.0 | 67.0 | # Get Inventory Allocation Line Item Data Allocation data associated to a line item. ## JSON Example { "lineItemId": "802SB00000LlpXdYAJ", "lineItemQuantity": 20, "productId": "01tSB000007D5DxYAK", "productName": "Speaker", "isSerialised": false, "successfulAllocatedQuantity": 12, "pendingAllocatedQuantity": 0, "requestedAllocatedQuantity": 12, "status": "PARTIALLY\_ALLOCATED", "allocations": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | allocations | [Get Inventory Allocation Location Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_location_data.htm "Allocation data associated to each location for the line item id.")\[\] | Allocated quantity per location for the line item. | Big, 66.0 | 66.0 | | isSerialised | Boolean | Product Serialisation boolean property. | Big, 66.0 | 66.0 | | lineItemId | String | Line Item Id. | Big, 66.0 | 66.0 | | lineItemQuantity | Double | Requested quantities of the product in the line item. | Big, 66.0 | 66.0 | | pendingAllocatedQuantity | Double | Aggregate quantity across locations that is pending allocation. | Big, 66.0 | 66.0 | | productId | String | Product Id of the requested product. | Big, 66.0 | 66.0 | | productName | String | Product Name. | Big, 66.0 | 66.0 | | requestedAllocatedQuantity | Double | Total quantity that was requested for allocation. | Big, 66.0 | 66.0 | | status | String | Allocation status of the line item. | Big, 66.0 | 66.0 | | successfulAllocatedQuantity | Double | Aggregate quantity across locations that was successfully allocated. | Big, 66.0 | 66.0 | # Get Inventory Allocation Location Data Allocation data associated to each location for the line item id. ## JSON Example { "locationId": "131SB000000VwnhYAC", "locationName": "Hyderabad", "availableQuantity": 100, "reservedQuantity": 12, "instanceReservations": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | availableQuantity | Double | Quantity available at location. | Big, 66.0 | 66.0 | | instanceReservations | [Get Inventory Allocation Instance Reservation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_instance_reservation.htm "Instance-level reservation for a serialized product not in a batch.")\[\] | Instance reservations for unbatched serialized products at this location. Only populated when instance reservations exist for the location allocation. | Big, 67.0 | 67.0 | | locationId | String | Location Id for the allocation. | Big, 66.0 | 66.0 | | locationName | String | Location Name. | Big, 66.0 | 66.0 | | reservedQuantity | Double | Quantity reserved for allocation. | Big, 66.0 | 66.0 | # Get Inventory Allocation Output Returns the allocation status, quantities, and source locations for all line items associated with a given entity. ## JSON Example { "isSuccess": true, "errorCode": null, "errorMessage": null, "errorDetails": \[\], "allocationData": \[\], "meta": { "pageNumber": 1, "pageSize": 10, "hasNext": false } } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | allocationData | [Get Inventory Allocation Line Item Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_line_item_data.htm "Allocation data associated to a line item.")\[\] | List of allocation data associated to the sourceId. | Big, 66.0 | 66.0 | | errorCode | String | The code of the error due to which the request failed. | Big, 66.0 | 66.0 | | errorDetails | String\[\] | List of detailed error information if the operation failed. | Big, 66.0 | 66.0 | | errorMessage | String | The details of the error if the operation failed. | Big, 66.0 | 66.0 | | isSuccess | Boolean | Indicates if the operation was successful (true) or not (false). | Big, 66.0 | 66.0 | | meta | [Pagination Meta](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_pagination_meta.htm "Pagination metadata for the API responses.")\[\] | Pagination data related to the API response. | Big, 66.0 | 66.0 | # GnrcVstKeyPerformanceInd Represents the key performance indicators that can be recorded while performing a task during a visit. You can compare the expected and actual metric values with the key performance indicator records. This object is available in Manufacturing Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualBooleanValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The actual boolean value recorded by the visitor for a key performance indicator. - **Possible values**: - False - True ### ActualDateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual date and time value recorded by the visitor for a key performance indicator. ### ActualDecimalValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual decimal value recorded by the visitor for a key performance indicator. ### ActualIntegerValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual integer value recorded by the visitor for a key performance indicator. ### ActualStringValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The actual string value recorded by the visitor for a key performance indicator. ### AssessmentIndDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment indicator definition associated with the record. This field is a relationship field. - **Relationship Name**: AssessmentIndDefinition - **Relationship Type**: Lookup - **Refers To**: AssessmentIndicatorDefinition ### DefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The definition record associated with the runtime record. The value is null when the definition record is created. This field is a relationship field. - **Relationship Name**: DefinitionReference - **Relationship Type**: Lookup - **Refers To**: GnrcVstKeyPerformanceInd ### ExpectedBooleanValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The expected boolean value defined by a manager for a key performance indicator. - **Possible values**: - False - True ### ExpectedDateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected date and time value defined by a manager for a key performance indicator. ### ExpectedDecimalValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected decimal value defined by a manager for a key performance indicator. ### ExpectedIntegerValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expected integer value defined by a manager for a key performance indicator. ### ExpectedStringValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The expected string value defined by a manager for a key performance indicator. ### IsDefinition - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is a definition (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier for the key performance indicator record. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the key performance indicator can be recorded. ### UnitOfMeasure - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure associated with the key performance indicator. - **Default value**: Unit - **Possible values**: - Kilogram - Litre - Pack - Unit ### VisitTaskContextId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task context associated with the record. This field is a relationship field. - **Relationship Name**: VisitTaskContext - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GnrcVstKeyPerformanceIndChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[GnrcVstKeyPerformanceIndFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[GnrcVstKeyPerformanceIndHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. **[GnrcVstKeyPerformanceIndOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm):** Sharing rules are available for the object. **[GnrcVstKeyPerformanceIndShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm):** Sharing is available for the object. # GnrcVstTaskContextRelation Represents common attributes used for a visit task and a visit task context. This object is available in Manufacturing Cloud in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Autogenerated unique identifier for the visit task context relation record. ### VisitTaskContextId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task context associated with the record. This field is a relationship field. - **Relationship Name**: VisitTaskContext - **Relationship Type**: Lookup - **Refers To**: GenericVisitTaskContext ### VisitTaskContextSequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the visit task context that’s associated with the record can be performed. ### VisitTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The visit task associated with the record. This field is a relationship field. - **Relationship Name**: VisitTask - **Relationship Type**: Lookup - **Refers To**: GenericVisitTask ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GnrcVstTaskContextRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[GnrcVstTaskContextRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[GnrcVstTaskContextRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. **[GnrcVstTaskContextRelationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm):** Sharing rules are available for the object. **[GnrcVstTaskContextRelationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm):** Sharing is available for the object. # GoodsReceivedNote Represents a record created by the buyer to confirm the delivery of goods from a supplier. It is used to verify that the received items match the purchase order. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### GoodsReceivedNoteNumber - **Type**: Int - **Properties**: Filter, Group, idLookup, Sort - **Description**: The unique identifier and primary key for the Goods Received Note. ### SupplierAccount - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account of the supplier that provides the goods. ### GoodsReceivedDate - **Type**: datetime - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date and time on which the goods are received. ### InvoiceReferenceNumber - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The invoice number provided by the supplier. ### GoodsReceivedLocation - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location where the goods are received. ### ReceiverAccount - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account associated with the user who is receiving the goods. ### ReceivedBy - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The user who is receiving the goods. ### Comments - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: Additional notes or remarks related to the Goods Received Note. ### StatusCode - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Indicates the status of the Goods Received Note. - **Possible values**: - Approved - Cancelled - Closed - Draft - Inspected - PartiallyReceived - PendingInspection - PendingReceipt - Received - Rejected - Returned - Submitted ### PurchaseOrder - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The purchase order associated with the Goods Received Note. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the context in which the Goods Received Note is created. - **Possible values**: - Distributor Management - Purchase Order Management # GoodsReceivedNoteItem Represents a single line entry on the Goods Received Note (GRN) that details the receiving status of a specific product. It records the total quantity received and indicates how many units were damaged, short-delivered, or received in excess of the purchase order. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### GoodsReceivedNoteItemNumber - **Type**: Int - **Properties**: Filter, Group, idLookup, Sort - **Description**: A unique identifier for each item in the Goods Received Note. ### GoodsReceivedNote - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The parent Goods Received Note record for this item. ### QuantityonInvoice - **Type**: datetime - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity specified on the supplier’s invoice for this item. ### ReceivedQuantity - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The actual quantity of the item received. ### AcceptedQuantity - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity of the item accepted after inspection. ### DamagedQuantity - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity of the item that was damaged upon receipt. ### ShortageQuantity - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity shortage for this item compared to the order or invoice. ### ExcessQuantity - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity received in excess of what was ordered or invoiced. ### UnitofMeasure - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit of measure used to quantify the item. ### Product - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with this Goods Received Note item. ### PurchaseOrderItem - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The specific item number from the related purchase order. ### StatusCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current status of the item within the Goods Received Note process. - **Possible values**: - Approved - Cancelled - Closed - Draft - Inspected - PartiallyReceived - PendingInspection - PendingReceipt - Received - Rejected - Returned - Submitted ### Comments - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional notes or remarks related to this Goods Received Note item. ### LastSyncedInvReceivedQty - **Type**: double - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity received during the most recent inventory synchronization. ### InvSyncStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current status of the inventory synchronization process for this item. - **Possible values**: - Completed - Failed - InProgress - Pending ### InvSyncMessage - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details about the inventory synchronization, such as the reason for a synchronization failure. ### ProductItem - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product item associated with this Goods Received Note item. # GRNItemProductionBatch Represents production batch level details for a Goods Received Note (GRN) item, including quantities received, accepted, and damaged for a specific batch number. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AcceptedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of the item accepted after inspection. ### BatchNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The batch number of the associated production batch. ### Comments - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional notes or remarks related to this Goods Received Note item. ### DamagedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description** ### GoodsReceivedNoteItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Goods Received Note Item associated with this production batch. This field is a relationship field. - **Relationship Name**: GoodsReceivedNoteItem - **Relationship Type**: Master-detail - **Refers To**: GoodsReceivedNoteItem (the master object) ### LastSyncedInvReceivedQty - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity received during the most recent inventory synchronization. ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with this Goods Received Note item. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The production batch associated with this Goods Received Note Item. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### PurchaseOrderItemNumberId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The specific item number from the related purchase order. This field is a relationship field. - **Relationship Name**: PurchaseOrderItemNumber - **Refers To**: PurchaseOrderItem ### ReceivedQuantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The actual quantity of the item received. ### StatusCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The current status of the item within the Goods Received Note process. - **Possible values**: - Approved - Cancelled - Closed - Draft - Inspected - Partially Received - Pending Inspection - Pending Receipt - Received - Rejected - Returned - Submitted ### UnitofMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure used to quantify the item. This field is a relationship field. - **Relationship Name**: UnitofMeasure - **Refers To**: UnitOfMeasure ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GRNItemProductionBatchHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # GRNItemSerializedProduct Represents an individual serialized unit received against a Goods Received Note (GRN) item, which associates a specific serial number with the receipt and indicates whether the unit is damaged.. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Comments - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional notes or remarks related to this Goods Received Note item. ### GoodsReceivedNoteItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Goods Received Note Item associated with this serialized product. This field is a relationship field. - **Relationship Name**: GoodsReceivedNoteItem - **Relationship Type**: Master-detail - **Refers To**: GoodsReceivedNoteItem (the master object) ### GrnItemProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production batch associated with the Goods Received Note item that contains this serialized product. This field is a relationship field. - **Relationship Name**: GrnItemProductionBatch - **Refers To**: GRNItemProductionBatch ### IsAccepted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the serialized product is accepted. - **Default value**: false ### IsDamaged - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the serialized product is damaged. - **Default value**: false ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with this Goods Received Note item. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductionBatchId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The production batch associated with this serialized product. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### PurchaseOrderItemNumberId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The specific item number from the related purchase order. This field is a relationship field. - **Relationship Name**: PurchaseOrderItemNumber - **Refers To**: PurchaseOrderItem ### SerialNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The serial number associated with the product. ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serialized product for which the Goods Received Note was created. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Refers To**: SerializedProduct ### StatusCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The current status of the item within the Goods Received Note process. - **Possible values**: - Approved - Cancelled - Closed - Draft - Inspected - Pending Inspection - Pending Receipt - Received - Rejected - Returned - Submitted ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[GRNItemSerializedProductHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # Import Records from CSV File Action Import and convert data from an uploaded CSV file into records of the target object. This action is available in API version 55.0 and later. ## Special Access Rules To access the Import Records from CSV File action, enable the Import CSV for Advanced Account Forecasting system permission with the Manufacturing Advanced Account Forecast permission set, or enable the Manufacturing Program Based Business permission set. ## Supported REST HTTP Methods **URI:** /services/data/v55.0/actions/standard/importRecordsFromCsvFile **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs
Input Type Description
externalIdFieldName string

Required.

The name of the target object field that contains the external ID. The external ID is used to identify the records with the upsert operation to the processed CSV file's data.

Note: The externalIdFieldName input is optional if the operationType input is insert.

operationType string Required.

The type of operation to be performed on the CSV file. Valid values are:

  • upsert
  • insert
receivedDocumentId string Required.

The ID of the received document record to be converted.
targetObjectApiName string Required.

The API name of the object that’s used to convert the CSV file data into records.
## Outputs None. ## Example **GET** This example shows how to get the details of the Import Records from CSV File action type. curl --include --request GET \\ --header "Authorization: Authorization: Bearer 00DR...xyz" \\ --header "Content-Type: application/json" \\ "https://instance.salesforce.com/services/data/v55.0/actions/standard/importRecordsFromCsvFile" **POST** Here’s a request for the Import Records from CSV File action. { "inputs":\[{ "receivedDocumentId" : "0ioT10000000043IAA", “targetObjectApiName” : "MfgProgramForecastFact", "operationType" : "upsert", "externalIdFieldName" : "ExternalId\_\_c" }\] } Here’s a response for the Import Records from CSV File action. \[ { "actionName" : "importRecordsFromCsvFile", "errors" : null, "isSuccess" : true }\] # ind\_mfg\_sample\_mgmt\_apex Namespace The ind\_mfg\_sample\_mgmt\_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards. The following are the classes in the ind\_mfg\_sample\_mgmt\_apex namespace. - **[ProductRequirementSpecification Class](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification)** Represents the resulting product requirement specification data. - **[ProductRequirementSpecificationItem Class](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem)** A list of items for this specification version. - **[ProductRequirementSpecificationVersion Class](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion)** A list of versions for this specification. # IndustriesConnectedServiceSettings Represents the settings for enabling Manufacturing cloud feature Telemetry Definition and Action Management. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location IndustriesConnectedServiceSettings values are stored in the IndustriesConnectedServiceSettings.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version IndustriesConnectedServiceSettings components are available in API version 65.0 and later. ## Fields ### enablePrebuiltCmpntTlmtryMgmt - **Field Type**: boolean - **Description**: Indicates whether the prebuilt components for Telemetry Definition and Action Managements feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. The default value is false. ### enableTelemetryDefActnMgmt - **Field Type**: boolean - **Description**: Indicates whether the Telemetry Definition and Action Management feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. The default value is false. ## Declarative Metadata Sample Definition The following is an example of an IndustriesConnectedServiceSettings component. false true The following is an example package.xml that references the previous definition. IndustriesConnectedService Settings 65.0 # IndustriesEventOrchSettings Represents the settings for enabling Manufacturing cloud feature like Event Orchestration Decision Table. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location IndustriesEventOrchSettings values are stored in the IndustriesEventOrch.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version IndustriesEventOrchSettings components are available in API version 60.0 and later. ## Fields ### enableEventOrchDecisionTable - **Description**: Indicates whether the Event Orchestration Decision Table feature of Manufacturing Cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of an IndustriesEventOrchSettings component. true The following is an example package.xml that references the previous definition. IndustriesEventOrchSettings Settings 60.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # IndustriesFieldServiceSettings Represents the settings for enabling Manufacturing cloud features like Industries Field Services and Product Service Campaign Management. This type extends the Metadata metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location IndustriesFieldServiceSettings values are stored in the IndustriesFieldServiceSettings.settings file in the settings directory. ## Version IndustriesFieldServiceSettings components are available in API version 60.0 and later. ## Fields ### enableAutomotiveServiceCampaignManagement - **Field Type**: boolean - **Description**: Indicates whether the predefined components for Product Service Campaign Management feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 65.0 and later. - **Default value**: false ### enableIndustriesFieldService - **Field Type**: boolean - **Description**: Indicates whether the predefined components for Industries Field Services feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of an IndustriesFieldServiceSettings component. false false The following is an example package.xml that references the previous definition. IndustriesFieldService Settings 60.0 # IndustriesManufacturingSettings Represents the settings for enabling Manufacturing cloud features like Account Forecasts, Account Manager Targets, Manufacturing Programs (program-based business), and Sales Agreements. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location IndustriesManufacturingSettings values are stored in a single file named IndustriesManufacturing.settings in the settings directory. ## Version IndustriesManufacturingSettings components are available in API version 47.0 and later. ## Fields ### enableConnectedAssetSrvcsCmpnt - **Field Type**: boolean - **Description**: Indicates whether the predefined components for Connected Asset Services feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 61.0 and later. - **Default value**: false ### enableIndManufacturing - **Field Type**: boolean - **Description**: Indicates whether the Sales Agreements feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgAccountForecast - **Field Type**: boolean - **Description**: Indicates whether the Account Forecasts feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgAdvForecast - **Field Type**: boolean - **Description**: Indicates whether the Advanced Account Forecasting feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ### enableIndustriesMfgIAS - **Field Type**: boolean - **Description**: Indicates whether the Default Analytics Dashboards setting, available with the Sales Agreements feature, of Manufacturing cloud is enabled (true) or disabled (false) for your org. - **Default value**: false ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/ "HTML (New Window)"). ### enableIndustriesMfgProgram - **Field Type**: boolean - **Description**: Indicates whether the Manufacturing Programs (program-based business) feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. Available in API version 54.0 and later. - **Default value**: false ### enableIndustriesMfgTargets - **Field Type**: boolean - **Description**: Indicates whether the Account Manager Targets feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 49.0 and later. - **Default value**: false ### enableMfgAgents - **Field Type**: boolean - **Description**: Indicates whether the Manufacturing Agents feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 64.0 and later. - **Default value**: false ### enableMfgAgentsExprcCloud - **Field Type**: boolean - **Description**: Indicates whether the Manufacturing Agents for Experience Cloud feature is enabled (true) or disabled (false) for your org. This field is available from API version 67.0 and later. - **Default value**: false ### enableMfgAgentsPilot - **Field Type**: boolean - **Description**: Reserved for future use. ### enablePtnrLeadMgmtMappings - **Field Type**: boolean - **Description**: Indicates whether the Vehicle And Asset Finance feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 60.0 and later. - **Default value**: false ### enableVehAndAstLending - **Field Type**: boolean - **Description**: Indicates whether the Vehicle and Asset Lending feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 62.0 and later. - **Default value**: false ### enableVehicleAndAssetFinance - **Field Type**: boolean - **Description**: Indicates whether the Vehicle And Asset Finance feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 60.0 and later. - **Default value**: false ### enableVehAssetFinAddtnlCmpnts - **Field Type**: boolean - **Description**: Indicates whether the predefined components for Vehicle And Asset Finance feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. This field is available from API version 60.0 and later. - **Default value**: false ## Declarative Metadata Sample Definition The following is an example of a IndustriesManufacturingSettings component. true false false false false false false false false false true true true The following is an example package.xml that references the previous definition. IndustriesManufacturing Settings 47.0 # IndustriesMfgSampleManagementSettings Represents the setting for enabling Sample Management feature in Manufacturing. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the "Settings" name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location IndustriesMfgSampleManagementSettings values are stored in the IndustriesMfgSampleManagement.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version IndustriesMfgSampleManagementSettings components are available in API version 67.0 and later. ## Special Access Rules Your Salesforce org must have the Sample Management license enabled. ## Fields ### enableSampleManagement - **Field Type**: boolean - **Description**: Indicates whether the Sample Management feature of Manufacturing Cloud is enabled (true) or disabled (false) for your org. The default value is false. ## Declarative Metadata Sample Definition The following is an example of an IndustriesMfgSampleManagementSettings component. true The following is an example package.xml that references the previous definition. IndustriesMfgSampleManagement Settings 67.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # Inventory Allocation (GET) Fetches the allocation status, quantities, and source locations for all line items associated with a given entity. ## Resource /connect/inventory/allocation/${sourceId} ## Resource Example https://yourInstance.salesforce.com/services/data/v66.0/connect/inventory/allocation/${sourceId} ## Available Version 66.0 ## HTTP Methods GET ## Request Parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | pageNumber | Integer | The page number to return. | Optional | 66.0 | | pageSize | Integer | The number of line item allocation records to return per page. | Optional | 66.0 | | status | String | Filters results by allocation status. | Optional | 66.0 | ## Response Body for GET [Get Inventory Allocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_output.htm "Returns the allocation status, quantities, and source locations for all line items associated with a given entity.") # Inventory Allocation (POST) Allocates the given source locations along with allocated quantities to selected item IDs. ## Resource /connect/inventory/allocation ## Resource Example https://yourInstance.salesforce.com/services/data/v66.0/connect/inventory/allocation ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "allocationData": \[ { "sourceId": "0AoSG000006cqWo0AI", "items": \[ { "sourceItemId": "0CoSG000006cqWo0AI", "allocations": \[ { "allocatedQuantity": 10, "sourceLocationId": "131SG000001ErblYAC", "unbatchedSerializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } \], "deallocationLocationIds": \["131SG000001ErblYBD"\], "deallocations": \[ { "sourceLocationId": "131SG000001ErblYBE", "serializedProductIds": \["0SPRG0000009AA1AI", "0SPRG0000009AA2AI"\] } \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | allocationData | [Inventory Allocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_data.htm "List of records associated to a source ID.")\[\] | List of source or parent records for inventory allocation processing. | Required | 66.0 | ## Response Body for POST [Inventory Allocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_inventory_allocation_output.htm "Output representation for inventory allocation.") # Inventory Allocation Data List of records associated to a source ID. ## JSON Example { "sourceId": "0AoSG000006cqWo0AI", "items": \[\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [Inventory Allocation Item](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_item.htm "Individual inventory item ID with locations for allocation process.")\[\] | List of items data. | Required | 66.0 | | sourceId | String | The parent record ID. | Required | 66.0 | # Inventory Allocation Input Input representation for inventory allocation. ## JSON Example { "allocationData": \[ { "sourceId": "0AoSG000006cqWo0AI", "items": \[ { "sourceItemId": "0CoSG000006cqWo0AI", "allocations": \[ { "allocatedQuantity": 10, "sourceLocationId": "131SG000001ErblYAC", "unbatchedSerializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } \], "deallocationLocationIds": \["131SG000001ErblYBD"\], "deallocations": \[ { "sourceLocationId": "131SG000001ErblYBE", "serializedProductIds": \["0SPRG0000009AA1AI", "0SPRG0000009AA2AI"\] } \] } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | allocationData | [Inventory Allocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_data.htm "List of records associated to a source ID.")\[\] | List of source or parent records for inventory allocation processing. | Required | 66.0 | # Inventory Allocation Item Individual inventory item ID with locations for allocation process. ## JSON Example { "sourceItemId": "0CoSG000006cqWo0AI", "allocations": \[\], "deallocationLocationIds": \["131SG000001ErblYBA", "131SG000001ErblYCD"\], "deallocations": \[\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | allocations | [Inventory Allocation Location](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_location.htm "Individual location ID with allocated quantity.")\[\] | List of allocations data. | Required if deallocations is not provided. | 66.0 | | deallocationLocationIds | String\[\] | List of location IDs. | Optional | 66.0 | | deallocations | [Inventory Deallocation Location](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_location.htm "Individual location with serialized or batched product IDs for deallocation.")\[\] | List of deallocation data, including location and optional serialized product details. | Required if allocations is not provided. | 67.0 | | sourceItemId | String | The ID of the item. | Required | 66.0 | # Inventory Allocation Location Individual location ID with allocated quantity. ## JSON Example { "allocatedQuantity": 10, "sourceLocationId": "131SG000001ErblYAC", "unbatchedSerializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | allocatedQuantity | Double | Quantity allocated from the source location. | Required if the product is unbatched and non-serialized. | 66.0 | | sourceLocationId | String | The ID of the source location receiving the inventory. | Required | 66.0 | | unbatchedSerializedProductIds | String\[\] | List of serialized product IDs for non-batched serialized product items. | Required with non-batched serialized products only. | 67.0 | # Inventory Allocation Output Output representation for inventory allocation. ## JSON Example { "isSuccess": true, "errorCode": "", "errorMessage": "", "errorDetails": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | The code of the error due to which the request failed. | Big, 66.0 | 66.0 | | errorDetails | String\[\] | List of error details. | Big, 66.0 | 66.0 | | errorMessage | String | The details of the error if the operation failed. | Big, 66.0 | 66.0 | | isSuccess | Boolean | Indicates if the operation was successful (true) or not (false). | Big, 66.0 | 66.0 | # Inventory Deallocation (POST) Deallocates the given source locations for selected item IDs. ## Resource /connect/inventory/deallocation ## Resource Example https://yourInstance.salesforce.com/services/data/v66.0/connect/inventory/deallocation ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "deallocationData": \[ { "sourceId": "0AoSG000006cqWo0AI", "items": \[ { "sourceItemId": "0CoSG000006cqWo0AI", "sourceLocationIds": \["131SG000001ErblYAC", "131SG000001ErblYBC"\], "deallocations": \[ { "sourceLocationId": "131SG000001ErblYAC", "serializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | deallocationData | [Inventory Deallocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_data.htm "Source group containing inventory items for deallocation process.")\[\] | List of source groups containing inventory items for deallocation process. | Required | 66.0 | ## Response Body for POST [Inventory Deallocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_inventory_deallocation_output.htm "Output representation to cancel product item allocations.") # Inventory Deallocation Data Source group containing inventory items for deallocation process. ## JSON Example { "sourceId": "0AoSG000006cqWo0AI", "items": \[\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | items | [Inventory Deallocation Item](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_item.htm "Individual inventory item for deallocation process.")\[\] | List of inventory items under this parent. | Required | 66.0 | | sourceId | String | The ID of the source entity. | Required | 66.0 | # Inventory Deallocation Input Input representation to cancel product item allocations. ## JSON Example { "deallocationData": \[ { "sourceId": "0AoSG000006cqWo0AI", "items": \[ { "sourceItemId": "0CoSG000006cqWo0AI", "sourceLocationIds": \["131SG000001ErblYAC", "131SG000001ErblYBC"\], "deallocations": \[ { "sourceLocationId": "131SG000001ErblYAC", "serializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } \] } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | deallocationData | [Inventory Deallocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_data.htm "Source group containing inventory items for deallocation process.")\[\] | List of source groups containing inventory items for deallocation process. | Required | 66.0 | # Inventory Deallocation Item Individual inventory item for deallocation process. ## JSON Example { "sourceItemId": "0CoSG000006cqWo0AI", "sourceLocationIds": \["131SG000001ErblYAC", "131SG000001ErblYBC"\], "deallocations": \[\] } ## Properties
Name Type Description Required or Optional Available Version
deallocations Inventory Deallocation Location[] List of deallocation data, including location and optional serialized product details.
  • Required if sourceLocationIds is not provided.
  • Cannot be combined with sourceLocationIds.
 67.0
sourceItemId String The ID of the source item. Required 66.0
sourceLocationIds String[] List of location IDs.
  • Required if deallocations is not provided.
  • Cannot be combined with deallocations.
 66.0
# Inventory Deallocation Location Individual location with serialized or batched product IDs for deallocation. ## JSON Example { "sourceLocationId": "131SG000001ErblYAC", "serializedProductIds": \["0SPRG0000008AA1AI", "0SPRG0000008AA2AI"\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | serializedProductIds | String\[\] | List of serialized product IDs for batched or non-batched serialized products. | Optional | 67.0 | | sourceLocationId | String | ID of the source location for deallocation. | Required | 67.0 | # Inventory Deallocation Output Output representation to cancel product item allocations. ## JSON Example { "isSuccess": true, "errorCode": "", "errorMessage": "", "errorDetails": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | The code of the error due to which the request failed. | Big, 66.0 | 66.0 | | errorDetails | String\[\] | List of detailed error information if the operation failed. | Big, 66.0 | 66.0 | | errorMessage | String | The details of the error if the operation failed. | Big, 66.0 | 66.0 | | isSuccess | Boolean | Indicates if the operation was successful (true) or not (false). | Big, 66.0 | 66.0 | # InventoryAllocationSettings Represents the settings for enabling Manufacturing Cloud features like Inventory Allocation. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location InventoryAllocationSettings values are stored in the InventoryAllocation.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version InventoryAllocationSettings components are available in API version 66.0 and later. ## Fields ### enableInventoryAllocation - **Field Type**: boolean - **Description**: Indicates whether the Inventory Allocation feature of Manufacturing Cloud is enabled (true) or disabled (false) for your org. The default value is false. ## Declarative Metadata Sample Definition The following is an example of an InventoryAllocationSettings component. true The following is an example package.xml that references the previous definition. InventoryAllocation Settings 66.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # InventoryBatchItemReservation Represents the inventory reservation for a specific product batch associated with a given item reservation source. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InventoryItemReservationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The inventory item reservation associated with this batch reservation. This field is a relationship field. - **Relationship Name**: InventoryItemReservation - **Relationship Type**: Master-detail - **Refers To**: InventoryItemReservation (the master object) ### IsAutoReserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the reservation was automatically generated or manually entered by a user. - **Default value**: false ### ProductBatchItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product batch item associated with the reservation, specifying the product, batch, and location details used. This field is a relationship field. - **Relationship Name**: ProductBatchItem - **Refers To**: ProductBatchItem ### ProductItemId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product item associated with the serialized product. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of the product batch item reserved. ### ReservationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time at which the inventory reservation was created. ### ReservationItemSourceId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The order line item for which the reservation was created. This field is a polymorphic relationship field. - **Relationship Name**: ReservationItemSource - **Refers To**: OrderItem, ReturnOrderLineItem, WorkOrderLineItem ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the inventory reservation. - **Default value**: Reserved - **Possible values**: - Reserved - Cancelled - Fulfilled ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryBatchItemReservationHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # InventoryCntProdtBatchItem Represents the inventory count of a batch of a product at a location. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### InventoryCountAssessment - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Inventory count assessment associated with the inventory count product batch item. ### ProductBatchItem - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Product batch item associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: ProductBatchItem ### InventoryCountProductItem - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Inventory count product item associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: InventoryCountProductItem ### Assignee - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Person who counts the inventory. - **Relationship Type**: Lookup - **Refers To**: User, Contact ### ActualStartDate - **Type**: dateTime - **Properties**: Create, Filter, Group, Sort - **Description**: Actual start date and time for counting the batch's inventory. ### ActualEndDate - **Type**: dateTime - **Properties**: Create, Filter, Group, Sort - **Description**: Actual end date and time for counting the batch's inventory. ### IsBlindCount - **Type**: boolean - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates whether the expected inventory quantity is visible to the assignee during inventory counting (true) or not (false). ### ActualQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Actual quantity of the batch's inventory. ### ExpectedQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Expected quantity of the batch's inventory. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Status of inventory count product batch item. ### DiscrepancyReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the type of reason for discrepancy between actual quantity and expected quantity. ### Comment - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: Comment, note, or instruction that gives additional context for the count of the batch's inventory. ### IsSerializedProduct - **Type**: boolean - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates whether the product being counted is serialized (true) or not (false). ### ProductionBatch - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Production batch associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: ProductionBatch ### Product - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Product associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: product2 ### ProductItem - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Product item associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: ProductItem ### LocationOwner - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Owner of the location associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: User, UserGroup ### Location - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Location associated with the inventory count product batch item. - **Relationship Type**: Lookup - **Refers To**: Location ### DiscrepancyInQuantity - **Type**: boolean - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates whether there's a discrepancy between the actual quantity and the expected quantity (true) or not (false). # InventoryCntSerializedProdt Represents a serialized product in an inventory count. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Count must be enabled. ## Fields ### InventoryCountAssessmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The inventory count assessment that's associated with the inventory count serialized product. This field is a relationship field. - **Relationship Name**: InventoryCountAssessment - **Relationship Type**: Master-detail - **Refers To**: InventoryCountAssessment (the master object) ### InventoryCountProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count product item that's associated with the inventory count serialized product. This field is a relationship field. - **Relationship Name**: InventoryCountProductItem - **Refers To**: InventoryCountProductItem ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the inventory count serialized product. ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serialized product that is associated with the inventory count serialized product. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Refers To**: SerializedProduct ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryCntSerializedProdtFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryCntSerializedProdtHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # InventoryCountAssessment Represents an inventory count performed at a location. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Count must be enabled. ## Fields ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person who counts the inventory. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: Contact, User ### InventoryCountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Inventory count plan associated with the inventory count. This field is a relationship field. - **Relationship Name**: InventoryCountPlan - **Refers To**: InventoryCountPlan ### IsBlindCount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expected inventory quantity is hidden from the assignee when they count the inventory (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Location associated with the inventory count. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the inventory count assessment. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PlannedEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Planned end date and time for the inventory count. ### PlannedStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Planned start date and time for the inventory count. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of inventory count. - **Possible values**: - Assigned - AuditorApproved—Auditor Approved - Complete—Completed - InProgress—In Progress ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of inventory count. - **Possible values**: - Adhoc - Audited - Initial - Periodic ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryCountAssessmentFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryCountAssessmentHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[InventoryCountAssessmentShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # InventoryCountPlan Represents a plan to count inventory at a location. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Count must be enabled. ## Fields ### CountInterval - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The interval between the planned start dates of two consecutive assessments related to this plan. For example, if the Count Interval is 5 and the Count Interval Unit of Measure is Monthly, then the interval between the planned start dates of the assessments is five months. ### CountIntervalUnitOfMeasure - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The unit of measure of the interval between two consecutive assessments related to this plan. If you select Once, only one assessment is created. - **Default value**: Once - **Possible values**: - Day - Month - Once - Quarter - Week - Year ### CountWindowDays - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days between the planned start and end date of each assessment related to this plan. For example, if the count window days is 5, and the planned start date of an assessment in this plan is January 4, 2024 at 9:00 AM, then the planned end date of that assessment is January 9, 2024 at 9:00 AM. If you don't specify a value, then the count interval is considered as the count window. ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the inventory count plan. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the inventory count is planned to end. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The location associated with the inventory count plan. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the inventory count plan. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the inventory count is planned to start. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the inventory count plan. - **Default value**: Draft - **Possible values**: - Active - Draft - Inactive ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryCountPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryCountPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[InventoryCountPlanShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # InventoryCountPlanItem Represents a product in an inventory plan. Inventory Count Plan Item is the child object of Inventory Count Plan. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Count must be enabled. ## Fields ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The assignee who's scheduled to count the product's inventory. This field is a relationship field. - **Relationship Name**: Assignee - **Refers To**: User ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A comment, note, or instruction that gives additional context for the plan to count the product's inventory. ### InventoryCountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The inventory count plan associated with the inventory count plan item. This field is a relationship field. - **Relationship Name**: InventoryCountPlan - **Relationship Type**: Master-detail - **Refers To**: InventoryCountPlan (the master object) ### IsBlindCount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expected inventory quantity is hidden from the assignee when they count the inventory (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location associated with the inventory count plan item. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the inventory count plan item. ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the inventory count plan item. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: Product2 ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryCountPlanItemFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryCountPlanItemHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # InventoryCountProductItem Represents the inventory count of a product at a location. Inventory Count Product Item is a child object of Inventory Count. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Count must be enabled. ## Fields ### ActualEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The planned end date for counting the product's inventory. ### ActualQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual quantity of the product's inventory. ### ActualStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual start date for counting the product's inventory. ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person who counts the product's inventory. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: User ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A comment, note, or instruction that gives additional context for the count of the product's inventory. ### DiscrepancyReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of reason for the discrepancy in the actual quantity and the expected quantity. ### ExpectedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected quantity of the product's inventory. ### InventoryAccuracy - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The actual quantity, expressed as a percentage of the expected quantity. This field is a calculated field. ### InventoryCountAssessmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The inventory count assessment that's associated with the inventory count product item. This field is a relationship field. - **Relationship Name**: InventoryCountAssessment - **Relationship Type**: Master-detail - **Refers To**: InventoryCountAssessment (the master object) ### InventoryCountPlanItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count plan item that's associated with the inventory count product item. This field is a relationship field. - **Relationship Name**: InventoryCountPlanItem - **Refers To**: InventoryCountPlanItem ### IsBlindCount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expected inventory quantity is hidden from the assignee when they count the inventory (true) or not (false). - **Default value**: false ### IsSerializedProduct - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the product being counted is serialized (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the inventory count product item. ### PlannedEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The planned end date for counting the product's inventory. ### PlannedStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The planned start date for counting the product's inventory. ### Product - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product that's associated with the inventory count product item. ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item that's associated with the inventory count product item. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit of measure of the expected and actual quantities of the inventory count product item. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the inventory count product item. - **Default value**: Assigned - **Possible values**: - Assigned - Complete - In\_Progress—In Progress - Inactive ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryCountProductItemFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryCountProductItemHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # InventoryOperation Represents operations performed on the inventory, such as transfers, disbursements, or adjustments. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores additional information about the inventory operation. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comments for the inventory operation. ### DestinationAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The address at which the products are delivered. This field is a relationship field. - **Relationship Name**: DestinationAddress - **Refers To**: Address ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the destination location associated with the inventory operation. This field is a relationship field. - **Relationship Name**: DestinationLocation - **Refers To**: Location ### IsDuplicate - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation is a duplicate (true) or not (false). - **Default value**: false ### IsException - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation has any exception (true) or not (false). - **Default value**: false ### IsSystemCreated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation is created by the system (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the inventory operation record. ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of inventory operation. - **Possible values**: - Adjustment - Disbursement - Return - Transfer - TransferIn—Transfer In - TransferOut—Transfer Out ### OpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The opportunity associated with the inventory operation. This field is a relationship field. - **Relationship Name**: Opportunity - **Refers To**: Opportunity ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the inventory operation record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product request associated with the inventory operation. This field is a relationship field. - **Relationship Name**: ProductRequest - **Refers To**: ProductRequest ### RelatedOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the related operation associated with the inventory operation. This field is a relationship field. - **Relationship Name**: RelatedOperation - **Refers To**: InventoryOperation ### ShipmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status indicating the condition of the shipment. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the source location associated with the inventory operation. This field is a relationship field. - **Relationship Name**: SourceLocation - **Refers To**: Location ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the visit associated with the inventory operation. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryOperationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[InventoryOperationFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[InventoryOperationHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[InventoryOperationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner."):** Sharing rules are available for the object. **[InventoryOperationShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # InventoryReplenishmentPolicy Represents a policy for replenishing inventory when the inventory quantity reaches a minimum level. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Inventory Replenishment must be enabled. ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the inventory replenishment policy. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the inventory replenishment policy is no longer effective. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the inventory replenishment policy becomes effective. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LocationReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location associated with the inventory replenishment policy. This field is a polymorphic relationship field. - **Relationship Name**: LocationReferenceRecord - **Refers To**: Location ### MaximumInventoryQuantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The maximum quantity for the inventory. ### MinimumInventoryQuantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The minimum quantity of the inventory at which the inventory is replenished. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the inventory replenishment policy. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product or the product classification associated with the inventory replenishment policy. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: Product2, ProductCategory ### ReplenishmentAction - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the action taken to replenish inventory. - **Default value**: ProductRequest - **Possible values**: - ProductRequest—Product Request ### ReplenishmentQuantityFormula - **Type**: textarea - **Properties**: Create, Filter, Sort, Update - **Description**: The formula to calculate the replenishment quantity. For example, MaximumQuantity - ProductItem.QuantityOnHand. ### ReplenishmentSourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location from which the product is replenished. This field is a relationship field. - **Relationship Name**: ReplenishmentSourceLocation - **Refers To**: Location ### ReplenishmentSrcLocCriterion - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the criterion of determining the replenishment source location - **Default value**: ReplenishmentSourceLocation - **Possible values**: - ProductFulfillmentLocation—Product Fulfillment Location - ReplenishmentSourceLocation—Replenishment Source Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the inventory replenishment policy. - **Default value**: Draft - **Possible values**: - Active - Draft - Inactive ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InventoryReplenishmentPolicyHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[InventoryReplenishmentPolicyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner."):** Sharing rules are available for the object. **[InventoryReplenishmentPolicyShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # InventoryReplenishmentSettings Represents the setting for enabling Inventory Replenishment feature. ## Parent Type and Manifest Access This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. ## File Suffix and Directory Location InventoryReplenishmentSettings values are stored in the InventoryReplenishment.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version InventoryReplenishmentSettings components are available in API version 63.0 and later. ## Fields ### enableInventoryReplenishment - **Field Type**: boolean - **Description**: Indicates whether the Inventory Replenishment feature of Manufacturing cloud is enabled (true) or disabled (false) for your org. The default value is false. ## Declarative Metadata Sample Definition The following is an example of an InventoryReplenishmentSettings component. true The following is an example package.xml that references the previous definition. InventoryReplenishment Settings 63.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # InvItemInstanceReservation Represents the inventory reservation for a specific item instance for a given item reservation source. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InventoryItemReservationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The item reservation associated with a specific unit. This field is a relationship field. - **Relationship Name**: InventoryItemReservation - **Relationship Type**: Master-detail - **Refers To**: InventoryItemReservation (the master object) ### InventoryBatchItemReservationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The batch item reservation for a specific unit. This field is a relationship field. - **Relationship Name**: InventoryBatchItemReservation - **Refers To**: InventoryBatchItemReservation ### IsAutoReserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the reservation was automatically generated or manually entered by a user. - **Default value**: false ### ItemInstanceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The item instance that represents the specific product being reserved. This field is a polymorphic relationship field. - **Relationship Name**: ItemInstance - **Refers To**: SerializedProduct ### ProductBatchItemId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product batch Item associated with the serialized product. This field is a relationship field. - **Relationship Name**: ProductBatchItem - **Refers To**: ProductBatchItem ### ProductItemId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product Item associated with the serialized product. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ReservationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the inventory was reserved. ### ReservationItemSourceId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The order line item for which the reservation is created. This field is a polymorphic relationship field. - **Relationship Name**: ReservationItemSource - **Refers To**: OrderItem, ReturnOrderLineItem, WorkOrderLineItem ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the serialized product inventory reservation. - **Default value**: Reserved - **Possible values**: - Reserved - Cancelled - Fulfilled ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[InvItemInstanceReservationHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # LeadPreferredSeller Represents the relationship between a lead and the dealer account that the lead selects, or the relationship between a lead and the account that provides the lead. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated Account record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AccountRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The role of the Account in relation to the associated Lead, such as the Lead's preferred dealer or lead provider. - **Possible values**: - Dealer - LeadProvider—Lead Provider ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated Contact record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LeadId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated Lead record. This field is a relationship field. - **Relationship Name**: Lead - **Relationship Type**: Lookup - **Refers To**: Lead ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the lead preferred seller. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[LeadPreferredSellerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[LeadPreferredSellerFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[LeadPreferredSellerHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # Manufacturing Apex Reference Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Manufacturing Apex reference includes built-in Apex classes, interfaces, enums, and exceptions, grouped by namespace. - **[ind\_mfg\_sample\_mgmt\_apex Namespace](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_namespace_ind_mfg_sample_mgmt_apex.htm)** The ind\_mfg\_sample\_mgmt\_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards. #### See Also - [_Apex Developer Guide_](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_dev_guide.htm) # Manufacturing Cloud Associated Objects This section provides a list of objects associated to Manufacturing Cloud standard objects with their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/system_fields.htm "HTML (New Window)") in the Object Reference for Salesforce and Lightning Platform. To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspect the WSDL or use a schema viewer. - **[StandardObjectNameFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm)** StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object. - **[StandardObjectNameHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm)** StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object. - **[StandardObjectNameOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm)** StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner. - **[StandardObjectNameShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm)** StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. - **[StandardObjectNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm)** A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events. # Manufacturing Cloud Business APIs Manufacturing Cloud Business APIs are RESTful APIs that are sometimes available as Apex classes and methods. - **[REST Reference](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_cloud_apis_rest_references.htm)** You can access Manufacturing Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. # Manufacturing Cloud Fields on InventoryItemReservation Represents an inventory item reservation for a specific product and location. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only if a B2B Commerce, D2C Commerce, B2C Commerce or Salesforce Order Management license is enabled. #### See Also - [_Object Reference for the Salesforce Platform_: InventoryItemReservation](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_inventoryitemreservation.htm) ## Fields ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item record specifying the product and location details used in the allocation. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the inventory reservation. - **Possible values**: - CancellationInProgress - Cancelled - ReservationInProgress - Reserved - Fulfilled ### ReservationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort - **Description**: The date and time when the inventory was reserved. ### IsAutoReserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Update - **Description**: Indicates whether the reservation was created automatically by the system (true) or manually (false). - **Default value**: false # Manufacturing Cloud Fields on Standard Objects Manufacturing Cloud adds fields to standard Salesforce objects to manage sales agreements and account forecasts. Some standard Salesforce objects have additional fields when Manufacturing Cloud is enabled. These fields allow you to track metrics and data specifically for manufacturing work flows.
Manufacturing Cloud is available in Lightning Experience.
Available in: Enterprise, Unlimited, and Developer Editions.
- **[Manufacturing Cloud Fields on InventoryItemReservation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventoryitemreservation.htm)** Represents an inventory item reservation for a specific product and location. This object is available in API version 60.0 and later. - **[Manufacturing Cloud Fields on WorkOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_manufacturing_cloud_fields_on_workorderlineitem.htm)** Represents a subtask on a work order in field service. This object is available in API version 36.0 and later. # Manufacturing Cloud Fields on WorkOrderLineItem Represents a subtask on a work order in field service. This object is available in API version 36.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Work orders or Field Service must be enabled. #### See Also - [_Object Reference for the Salesforce Platform_: WorkOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_workorderlineitem.htm) ## Fields ### ProcessType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the process type of the work order. - **Possible values**: - DepotRepair ## Usage A work order line item is a child record of a work order. It represents a specific subtask on a work order. # Manufacturing Cloud Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. For more information about Metadata API and to find a complete reference of existing metadata types, see [Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/). The following list links to Metadata API types used in Manufacturing Cloud. - [AccountForecastSettings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_accountforecastsettings_metadata_api.htm "Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations.") Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations. - [AcctMgrTargetSettings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_acctMgrTargetSettings_metadata_api.htm "Represents the settings of account manager targets. These settings define the distribution frequency, the hierarchy of team members for assignments, and the default price book of account manager targets. This type also displays the record usage details by account manager targets in your Salesforce org. This type extends the Metadata metadata type and inherits its fullName field.") Represents the settings of account manager targets. These settings define the distribution frequency, the hierarchy of team members for assignments, and the default price book of account manager targets. This type also displays the record usage details by account manager targets in your Salesforce org. - [ActionableEventOrchDef](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actionableeventorchdef_metadata_api.htm "Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another.") Represents the definition of an actionable event orchestration so that the records can be migrated from one org to another. - [ActionableEventTypeDef](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actionableeventtypedef_metadata_api.htm "Represents the definition of an actionable event type so that the records can be migrated from one org to another.") Represents the definition of an actionable event type so that the records can be migrated from one org to another. - [AdvAccountForecastSet](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_advaccountforecastset.htm) Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Manufacturing Cloud](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_flow_metadata_api.htm "Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Manufacturing Cloud exposes additional actionType values for the FlowActionCall Metadata type. - [MfgProgramTemplate](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_mfgprogramtemplate.htm) Represents a definition of a program to create a program-based business. A program-based business, also known as a Manufacturing Program, enables manufacturers to drive their business models with forecasting tools and manage the end-to-end sales process efficiently. - [ObjectHierarchyRelationship](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/mfg_objecthierarchyrelationshipsettings_metadata_api.htm) Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct. - [SalesAgreementSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/mfg_salesagreementsettings_metadata_api.htm) Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements. - [Settings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_settings_metadata_api_parent.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. For more information, see Settings.") Represents the organization settings related to a feature. For example, your password policies, session settings, and network access controls are all available in the SecuritySettings component type. - [TelemetryActionDefinition](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_telemetryactiondefinition_metadata_api.htm "Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component.") Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. - [TelemetryActionDefStep](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_telemetryactiondefstep_metadata_api.htm "Represents a step in the action for a telemetry signal definition.") Represents a step in the action for a telemetry signal definition. - [TelemetryActnDefStepAttr](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_telemetryactndefstepattr_metadata_api.htm "Represents the attributes of a telemetry action definition step.") Represents the attributes of a telemetry action definition step. - [TelemetryDefinition](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_telemetrydefinition_metadata_api.htm "Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle.") Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. - [TelemetryDefinitionVersion](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_telemetrydefinitionversion_metadata_api.htm "Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle.") Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. # Manufacturing Cloud Standard Invocable Actions Automate business processes related to account forecast, sales agreements, and account manager target values by using the standard invocable actions for Manufacturing Cloud. For more information on standard invocable actions, see **[REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_actions_invocable_standard.htm)** and **[Actions Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_action.meta/api_action/actions_intro.htm)**. - **[Calculate Advanced Account Forecasts Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/actions_obj_calculate_forecasts.htm)** Calculate forecasts for an account based on the formulae associated with the forecast set. - **[Import Records from CSV File Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/actions_obj_import_records_from_csv_file.htm)** Import and convert data from an uploaded CSV file into records of the target object. - **[Refresh Actuals Calculation Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actions_refresh_actuals_calculation.htm)** Refresh actuals calculations for sales agreements for current and past periods. - **[Recalculate Forecasts Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actions_recalculate_forecast.htm)** Recalculate forecasts based on orders, opportunity, and sales agreement figures. - **[Mass Update Account Forecast Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actions_mass_update_account_forecast.htm)** Mass update account forecast fields for different products and periods with this single action. - **[Mass Update Sales Agreement Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actions_mass_update_sales_agreement.htm)** Now you can make mass updates to sales agreement fields for different products and periods with a single action. - **[Update Account Manager Target Values Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_actions_account_manager_target.htm)** Update an account manager target’s assignment values when the target’s value changes. The update is made based on the parent's target value and percentage. - **[Mass Update Advance Account Forecast Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/actions_mass_update_advaccount_forecast.htm)** Update a measure of AdvAccountForecastFact records based on filter condition of the selected list view. - **[Update Advanced Account Forecast Set Partner Action](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/actions_obj_update_adv_forecast_setpartner.htm)** Updates the status of the Advanced Account Forecast Set Partner record after the forecast data for a given combination of account and forecast set has been generated. # Manufacturing Cloud Standard Objects Manufacturing Cloud data model provides objects and fields to create and manage sales agreements and account forecasts. Use the objects for business negotiations and planning, and get an integrated sales experience.
Manufacturing Cloud is available in Lightning Experience.
Available in: Enterprise, Unlimited, and Developer Editions.
- **[AccountForecast](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_accountforecast.htm)** Represents the rolling forecast record of a particular account. The forecast is prepared using data directly from sales agreements, orders, and opportunities. This object is available in API version 47.0 and later. - **[AccountForecastAdjustment](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_accountforecastadjustment.htm)** Represents the manual adjustments made to forecast values for a particular account. This object is available in API version 47.0 and later. - **[AccountForecastPeriodMetric](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_accountforecastperiodmetric.htm)** Represents records of account metrics which vary by period but are not specific for a product. This object is available in API version 47.0 and later. - **[AccountProductForecast](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_accountproductforecast.htm)** Represents the cumulative values for planned quantities, opportunities, and orders of a sales agreement for a given product across all periods in that rolling time period. This object is available in API version 47.0 and later. - **[AccountProductPeriodForecast](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_accountproductperiodforecast.htm)** Represents the quantity and revenue information of opportunities, sales agreements, orders, and resultant forecasted quantities for a product in a particular time period of the forecast rolling period. Other than the fields AdjustedForecastQuantity and AdjustedForecastRevenue, no other fields of this object can be updated. This object is available in API version 47.0 and later. - **[AcctMgrPeriodicTargetDstr](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_periodic_target_distribution.htm)** Represents the target value of each period of an account manager target. It is a foreign key to either an account manager target and an account manager target distribution. It has twelve fields for periods and twelve corresponding fields to hold the target value. This object is available in API version 49.0 and later. - **[AcctMgrTarget](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_target.htm)** Represents a target created by an account manager. It stores the fiscal year, measure, target value, start date, end date, and assignment information of an account manager target. This object is available in API version 49.0 and later. - **[AcctMgrTargetDstr](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_target_distribution.htm)** Represents the account, product, and price book associated to an account manager target. It is a child object of the [AcctMgrTarget](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_target.htm "Represents a target created by an account manager. It stores the fiscal year, measure, target value, start date, end date, and assignment information of an account manager target. This object is available in API version 49.0 and later.") object. This object is available in API version 49.0 and later. - **[AcctMgrTargetMeasure](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_standard_object_account_manager_target_measure.htm)** Represents the type of measure for an account manager target. This object is a dynamic pick list table, which is referenced in account manager target. It is available in API version 49.0 and later. - **[AdvAcctForecastAdjPeriod](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastadjperiod.htm)** Represents details about the adjustment period of the advanced account forecast values. This object is available in API version 53.0 and later. - **[AdvAcctForecastDimension](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastdimension.htm)** Represents information about the dimensions selected for an advanced account forecast set. This object is available in API version 53.0 and later. - **[AdvAcctForecastDimSource](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastdimsource.htm)** Represents information about the dimensions that can be used by advanced account forecast sets to generate advanced account forecast records. This object is available in API version 53.0 and later. - **[AdvAcctFrcstDisplayGroup](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctfrcstdisplaygroup.htm)** Represents information about the groups for the advanced account forecast set measures or dimensions. This object is available in API version 54.0 and later. - **[AdvAcctFrcstDplyGroupItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctfrcstdplygroupitem.htm)** Represents information about the items associated with a display group for an advanced account forecast set. This object is available in API version 54.0 and later. - **[AdvAccountForecastFact](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advaccountforecastfact.htm)** Represents information about the generated advanced account forecast records. This object is available in API version 53.0 and later. - **[AdvAcctForecastFactAdj](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastfactadj.htm)** Represents information about adjustments made to advanced account forecast fact records. This object is available in API version 53.0 and later. - **[AdvAcctForecastMeasureDef](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastmeasuredef.htm)** Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. This object is available in API version 53.0 and later. - **[AdvAccountForecastPeriod](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advaccountforecastperiod.htm)** Represents information about the periods for which advanced account forecasting is applied. This object is available in API version 53.0 and later. - **[AdvAcctForecastPeriodGroup](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastperiodgroup.htm)** Represents information about advanced account forecast period records. This is the parent object of all the related advanced account forecast period records. This object is available in API version 53.0 and later. - **[AdvAccountForecastSet](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advaccountforecastset.htm)** Represents a collection of fields to set up an advanced account forecast set. This object is available in API version 53.0 and later. - **[AdvAcctForecastSetPartner](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastsetpartner.htm)** Represents a junction between an advanced account forecast set and an account. This object is available in API version 53.0 and later. - **[AdvAcctForecastSetUse](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_advacctforecastsetuse.htm)** Represents a junction between an advanced account forecast set and another object whose record serves as the context for generating forecasts. For example, a manufacturing program or a Sustainability Cloud object’s record can be the context for generating forecasts. This object is available in API version 55.0 and later. - **[AssetAccountParticipant](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_assetaccountparticipant.htm)** Represents a junction between the Asset and Account objects describing the association between a participating account and an asset. This object is available in API version 59.0 and later. - **[AssetContactParticipant](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_assetcontactparticipant.htm)** Represents a junction between the Asset and Contact objects describing the association between a participating contact and an asset. This object is available in API version 59.0 and later. - **[AssetMilestone](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_assetmilestone.htm)** Represents the key events in the lifecycle of an asset, such as manufacturing, registration, or resale. This object is available in API version 58.0 and later. - **[AssetWarranty](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_assetwarranty.htm)** Defines the warranty terms applicable to an asset along with any exclusions and extensions. This object is available in Manufacturing Cloud in API version 55.0 and later. - **[Claim](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_claim.htm)** Represents a warranty Claim submitted by a partner to a manufacturer, or a supplier recovery claim submitted by the manufacturer to a supplier. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[ClaimCoverage](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_claimcoverage.htm)** Represents a causal part in a defective asset that requires repair or replacement. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[ClaimCoveragePaymentDetail](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_claimcoveragepaymentdetail.htm)** Represents the claim coverage amount that must be paid to a claimant for a part replaced or replaced or a labor service performed to rectify a causal part in a defective asset. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[ClaimItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_claimitem.htm)** Represents a defective asset that requires repair or replacement. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[ClaimParticipant](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_claimparticipant.htm)** A junction object that associates the Claim object with the Account object. This object represents the participants of a claim. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[CodeSet](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_codeset.htm)** Represents various industry defined codes in the context of their systems and versions of those systems. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[CodesetRelationship](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_codesetrelationship.htm)** Represents a relationship between a codeset and its related codeset. For example, a labor code associated with a fault code. This object is available in Manufacturing Cloud in API version 58.0 and later. - **[DealerProdtSearchableField](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgdealerprodtsearchablefield.htm)** Represents information about dealers selling and, or, servicing products for location-based searches. Helps customers find nearby dealer locations for product purchases and services. This object is available in API version 65.0 and later. - **[EngagementAttendee](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_engagement_attendee.htm)** Represents information about an attendee of an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, this object stores information about the customer and the service representative. This object is available in API version 55.0 and later - **[EngagementInteraction](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_engagement_interaction.htm)** Represents information about an interaction between a service representative or any other specialist in an organization and the organization’s customer. Engagement interactions can be initiated through communication channels and can cover one or more topics. For example, a customer can initiate an engagement interaction by calling a service representative to inquire about an insurance claim. This object is available in API version 55.0 and later. - **[Fleet](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_fleet.htm)** Represents a group of assets used in commercial, service, or transport operations in the manufacturing industry. This object is available in API version 59.0 and later. - **[FleetAsset](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_fleetasset.htm)** Represents the relationship between an asset and the fleet to which it belongs. This object is available in API version 59.0 and later. - **[FleetParticipant](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_fleetparticipant.htm)** Represents the relationship between a fleet and a participant, such as an account, a contact, or a user. This object is available in API version 59.0 and later. - **[EngagementTopic](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_engagement_topic.htm)** Represents information about the topics discussed by a customer and other attendees during an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, the topic of the engagement is Claim. This object is available in API version 55.0 and later. - **[GnrcVstKeyPerformanceInd](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_gnrcvstkeyperformanceind.htm)** Represents the key performance indicators that can be recorded while performing a task during a visit. You can compare the expected and actual metric values with the key performance indicator records. This object is available in Manufacturing Cloud in API version 56.0 and later. - **[GenericVisitTask](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_genericvisittask.htm)** Represents information about a task that can be performed during a visit. This object is available in Manufacturing Cloud in API version 56.0 and later. - **[GenericVisitTaskContext](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_genericvisittaskcontext.htm)** Represents the context or purpose for a generic visit task. This object is available in Manufacturing Cloud in API version 56.0 and later. - **[GnrcVstTaskContextRelation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_gnrcvsttaskcontextrelation.htm)** Represents common attributes used for a visit task and a visit task context. This object is available in Manufacturing Cloud in API version 56.0 and later. - **[GRNItemProductionBatch](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_grnitemproductionbatch.htm)** Represents production batch level details for a Goods Received Note (GRN) item, including quantities received, accepted, and damaged for a specific batch number. This object is available in API version 67.0 and later. - **[GRNItemSerializedProduct](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_grnitemserializedproduct.htm)** Represents an individual serialized unit received against a Goods Received Note (GRN) item, which associates a specific serial number with the receipt and indicates whether the unit is damaged.. This object is available in API version 67.0 and later. - **[GoodsReceivedNote](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_goodsreceivednote.htm)** Represents a record created by the buyer to confirm the delivery of goods from a supplier. It is used to verify that the received items match the purchase order. This object is available in API version 65.0 and later. - **[GoodsReceivedNoteItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_goodsreceivednoteitem.htm)** Represents a single line entry on the Goods Received Note (GRN) that details the receiving status of a specific product. It records the total quantity received and indicates how many units were damaged, short-delivered, or received in excess of the purchase order. This object is available in API version 65.0 and later. - **[InventoryBatchItemReservation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorybatchitemreservation.htm)** Represents the inventory reservation for a specific product batch associated with a given item reservation source. This object is available in API version 67.0 and later. - **[InventoryCntSerializedProdt](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycntserializedprodt.htm)** Represents a serialized product in an inventory count. This object is available in API version 63.0 and later. - **[InventoryCountAssessment](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycountassessment.htm)** Represents an inventory count performed at a location. This object is available in API version 63.0 and later. - **[InventoryCountPlan](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycountplan.htm)** Represents a plan to count inventory at a location. This object is available in API version 63.0 and later. - **[InventoryCountPlanItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycountplanitem.htm)** Represents a product in an inventory plan. Inventory Count Plan Item is the child object of Inventory Count Plan. This object is available in API version 63.0 and later. - **[InventoryCountProductItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycountproductitem.htm)** Represents the inventory count of a product at a location. Inventory Count Product Item is a child object of Inventory Count. This object is available in API version 63.0 and later. - **[InventoryCntProdtBatchItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventorycntprodtbatchitem.htm)** Represents the inventory count of a batch of a product at a location. This object is available in API version 55.0 and later. - **[InvItemInstanceReservation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inviteminstancereservation.htm)** Represents the inventory reservation for a specific item instance for a given item reservation source. This object is available in API version 67.0 and later. - **[InventoryOperation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventory_operation.htm)** Represents operations performed on the inventory, such as transfers, disbursements, or adjustments. This object is available in API version 65.0 and later. - **[InventoryReplenishmentPolicy](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_inventoryreplenishmentpolicy.htm)** Represents a policy for replenishing inventory when the inventory quantity reaches a minimum level. This object is available in API version 63.0 and later. - **[LeadPreferredSeller](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_leadpreferredseller.htm)** Represents the relationship between a lead and the dealer account that the lead selects, or the relationship between a lead and the account that provides the lead. This object is available in API version 65.0 and later. - **[ManufacturingProgram](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_manufacturingprogram.htm)** Represents information about a manufacturing program. For example, Verican X program for Verican Account to manufacture auto components for their upcoming concept vehicle, staring from 01-Jan-2022 and valid until 01-Dec-2024. This object is available in API version 55.0 and later. - **[MfgProgramCpntFrcstFact](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgprogramcpntfrcstfact.htm)** Represents information about the generated manufacturing program component forecast records. This object is available in API version 55.0 and later. - **[MfgProgramForecastFact](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgprogramforecastfact.htm)** Represents information about the generated manufacturing program forecast records. This object is available in API version 55.0 and later. - **[MfgProgramTemplate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgprogramtemplate.htm)** Represents information about the templates associated with a manufacturing program. This object is available in API version 55.0 and later. - **[MfgPgmCpntFrcstFactOpptySchd](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgpgmcpntfrcstfactopptyschd.htm)** Represents a junction between the forecast and opportunity line item schedule objects, providing details on the relationship between forecast data and corresponding sales order schedules. This object is available in API version 55.0 and later. - **[MfgProgramTemplateItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgprogramtemplateitem.htm)** Represents information about the transformation type associated with a manufacturing program template. This object is available in API version 55.0 and later. - **[MfgProgramVariantFrcstFact](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_mfgprogramvariantfrcstfact.htm)** Represents information about the generated manufacturing program product variant forecast records. This object is available in API version 55.0 and later. - **[OpportunityPreferredSeller](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_opportunitypreferredseller.htm)** Represents the relationship between an opportunity and a dealer account, or the relationship between an opportunity and the account that provided the lead from which the opportunity was created. This object is available in API version 65.0 and later. - **[ProductionBatch](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productionbatch.htm)** Represents the batch of homogeneous products manufactured in the same production line. This object is available in API version 65.0 and later. - **[ProductBatchItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productbatchitem.htm)** Represents the details about the product items in each batch. This object is available in API version 65.0 and later. - **[ProductConsumed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productconsumed.htm)** Represents an item from your product inventory that was used to complete a work order or work order line item. This object is available in API version 60.0 and later. - **[ProductConsumedState](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productconsumedstate.htm)** Represents an action taken to associate a serialized product with a product transfer. The new state is a result of the action. A product transfer state record is created when serialized products are attached to the product transfer. This object is available in API version 60.0 and later. - **[ProductFaultCode](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productfaultcode.htm)** Represents a relationship between a product or product family and the fault code. This object is available in API version 58.0 and later. - **[ProductInventoryBatchSearchableField](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productinventorybatchsearchfield.htm)** Represents production batch data used for inventory search, including batch item details for a specific location. This data serves as the basis for Criteria-Based and Filter Search, which combines batch details with standard inventory dimensions. This object is available in API version 47.0 and later. - **[ProductInvSearchableField](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productinvsearchablefield.htm)** Represents a dataset on inventory information that's the basis for searching product inventory. Contains multiple fields from Product Item and related objects. This object is available in API version 62.0 and later. - **[ProductItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productitem.htm)** Represents the stock of a product at a particular inventory location, such as a warehouse or a distribution lot. Product item records represent your inventory. A product item is associated with an inventory location and stores the quantity of products at that location. This object is available in API version 60.0 and later. - **[ProductItemAddlTrxn](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_sforce_api_objects_productitemaddltrxn.htm)** Represents an individual transaction that records a change in the state and quantity of a specific product item. This object is available in API version 67.0 and later. - **[ProductItemTransaction](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productitemtransaction.htm)** Represents an action taken on a product item. Product item transactions track when a product is consumed, replenished, adjusted, or transferred. Product item transactions are auto-generated records that specify the quantity of products impacted by the action. This object is available in API version 60.0 and later. - **[ProductLaborCode](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productlaborcode.htm)** Represents a junction between the labor code that's applicable to a product or product family and the required standard effort. This object is available in API version 58.0 and later. - **[ProductRelatedMaterial](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrelatedmaterial.htm)** Represents information about the components of a product. This object is available in API version 55.0 and later. - **[ProductRequest](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrequest.htm)** Represents a request or an order for products to and from specific inventory locations. This object is available in API version 60.0 and later. - **[ProductRequestLineItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrequestlineitem.htm)** Represents a product that’s requested as a part of a product request. Product request line items are components of product requests. Each line item is associated with a specific product being requested. This object is available in API version 60.0 and later. - **[ProductRequired](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrequired.htm)** Represents a product that is needed to complete a work order or work order line item. This object is available in API version 60.0 and later. - **[ProductRqmtSpec](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrqmtspec.htm)** Defines a complete set of requirements. It captures key information such as the associated Account and Contact, tracks its overall lifecycle status, and acts as the parent for all related requirement items and their versions. This object is available in API version 65.0 and later. - **[ProductRqmtSpecItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrqmtspecitem.htm)** Represents a specific and measurable requirement within a requirement specification for a requested product. Defines what must be delivered and how to verify its fulfilment. This object is available in API version 65.0 and later. - **[ProductRqmtSpecVersion](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productrqmtspecversion.htm)** Represents a specific, numbered snapshot of a Requirement Specification at a particular time, outlining the purpose, scope, constraints, and validation methods. This object is available in API version 65.0 and later. - **[ProductServiceCampaign](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productservicecampaign.htm)** Represents a set of activities to be performed for a product service campaign. For example, a recall of products due to potential safety hazards or an upgrade of products to comply with legal regulations. This object is available in API version 61.0 and later. - **[ProductServiceCampaignItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productservicecampaignitem.htm)** Represents an item, such as an asset or a serialized product, that’s included in a product service campaign. This object is available in API version 61.0 and later. - **[ProductSvcCampaignDef](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productsvccampaigndef.htm)** Represents information about the product or part that is impacted in a product service campaign. Stores the granular details related to product faults, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProductSvcCampaignGrpDef](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productsvccampaigngrpdef.htm)** Represents information about product service campaign definitions within groups based on attributes, such as the origin, status, or consequences of a campaign. Helps compliance officers define the scope and type of a product service campaign group before execution. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnGrpDefCausalItm](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpngrpdefcausalitm.htm)** Represents information about the impacted item that caused the service campaign to be initiated, such as an airbag that needs to be repaired or replaced. Stores the granular details related to the causal item, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnGrpDefPtnr](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpngrpdefptnr.htm)** Represents information about the coordinating partner, such as a supplier or a distributor, that needs to be communicated regarding a particular product service campaign. Stores the granular details related to the partner, such as the channel of communication with them, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnDefPtnrInv](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpndefptnrinv.htm)** Represents information about the partner-held inventory of the items that are impacted by a product service campaign. Stores the granular details, such as inventory status and impacted unit count, facilitating simplified tracking and efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnDefRelaCausalItm](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpndefrelacausalitm.htm)** Represents information about the cause associated with a product service campaign definition. Helps to efficiently identify and map faulty parts to the products that need to be repaired or replaced through the product service campaign. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnPreferredPartner](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpnpreferredpartner.htm)** Represents information about the most appropriate partner to execute a product service campaign within a specific geographic area. Helps to map and allocate service providers to minimize costs and turnaround time,facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProdtSvcCmpnWorkType](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_prodtsvccmpnworktype.htm)** Represents information about the eligible work types that can be associated with a product service campaign. Helps to identify and track the work types related to the impacted items, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. - **[ProductTransfer](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_producttransfer.htm)** Represents the transfer or the movement of a product item between two inventory locations. This object is available in API version 60.0 and later. - **[ProductTransferState](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_producttransferstate.htm)** Represents an action taken to associate a serialized product with a product transfer. The new state is a result of the action. A product transfer state record is created when serialized products are attached to the product transfer. This object is available in API version 60.0 and later. - **[ProductWarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_productwarrantyterm.htm)** Defines the relationship between a product or product family and a warranty term. This object is available in Manufacturing Cloud in API version 55.0 and later. - **[PurchaseOrder](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_purchaseorder.htm)** Represents the Purchase Order entity that captures a formal request from a Buyer to a Supplier to supply goods or services. It is identified by a unique PurchaseOrderNumber and tracks the order's lifecycle via a StatusCode. It defines commercial terms like the TotalAmount, BillingAccount, and the governing PriceBook. This object is available in API version 65.0 and later. - **[PurchaseOrderItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_purchaseorderitem.htm)** Represents an individual line on a parent Purchase Order, detailing a specific product or service being procured. It captures the core transactional data including the Quantity, UnitPrice, a reference to the Product, and the calculated LineTotal. This object is available in API version 65.0 and later. - **[ReturnOrder](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_returnorder.htm)** Represents the repair, return, or recall of product items. This object is available in API version 60.0 and later. - **[ReturnOrderLineItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_returnorderlineitem.htm)** Represents a product that is returned, recalled, or repaired as part of a return order. This object is available in API version 60.0 and later. - **[SalesAgreement](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreement.htm)** Represents a long-term agreement between a buyer and a seller to negotiate price and volume of products.This object is available in API version 47.0 and later. - **[SalesAgreementProduct](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreementproduct.htm)** Represents the total quantity or amount and the default pricing information of a product or category across the total time period of the sales agreement.This object is available in API version 47.0 and later. - **[SalesAgreementProdSchdAdj](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreementprodschdadjustment.htm)** Represents the manual adjustments made to metric values for a sales agreement product schedule. This object is available in API version 47.0 and later. - **[SalesAgreementProductSchedule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreementproductschedule.htm)** Represents the quantity or amount and the pricing information of a product or category for a particular schedule of the sales agreement. This object is available in API version 47.0 and later. - **[SalesAgreeProductAttribute](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreeproductattribute.htm)** Represents a virtual object that stores the key-value pairs for attributes of sales agreement products. This object is available in API version 60.0 and later. - **[SalesContractLine](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salescontractline.htm)** Stores a contract's product information, including price, quantity, and components covered. This object is available in API version 59.0 and later. - **[SampleRequest](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_samplerequest.htm)** Represents a request for product samples, including customer account details, request date and status. This object is available in API version 65.0 and later. - **[SampleRequestItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_samplerequestitem.htm)** Represents information on items associated with a sample request, including details such as product, custom specifications, quantity and price. This object is available in API version 65.0 and later. - **[SellerProduct](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_sellerproduct.htm)** Represents information about the products associated with a seller. Provides insight into product availability, production details, and the seller's role for the product, such as for sales or for service. This object is available in API version 65.0 and later. - **[SerializedProduct](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_serializedproduct.htm)** Records serial numbers for each product in an inventory. This object is available in API version 60.0 and later. - **[SerializedProductTransaction](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_serializedproducttransaction.htm)** Represents a change in the state of a serialized product. This object is available in API version 60.0 and later. - **[Shipment](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_shipment.htm)** Represents a product item that’s in transit between two inventory locations. This object is available in API version 60.0 and later. - **[ShipmentItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_shipmentitem.htm)** Represents a product that’s included in a shipment. This object is available in API version 60.0 and later. - **[Supplier](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_supplier.htm)** Represents information about a supplier that a manufacturer procures product parts and components from. This object is available in API version 59.0 and later. - **[SupplierProduct](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_supplierproduct.htm)** Represents information about a product that’s procured from a supplier. This object is available in API version 59.0 and later. - **[StockRotationExecution](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_stockrotationexecution.htm)** Represents a stock rotation rebate activity, recording affected inventory and partner information for rebate claim processing. This object is available in API version 65.0 and later. - **[StockRotationExecutionItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_stockrotationexecutionitem.htm)** Represents the affected partner inventory in a stock rotation rebate execution, used to determine claim eligibility. This object is available in API version 65.0 and later. - **[Visit](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_visit.htm)** Represents information about a visit that a manager schedules for a field rep to perform, usually at distributor, supplier, and partner locations. This object is available in API version 56.0 and later. - **[WarrantyTerm](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_warrantyterm.htm)** Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in Manufacturing Cloud in API version 55.0 and later. - **[WarrantyTermCoverage](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_warrantytermcoverage.htm)** Represents a junction between the warranty term coverage and a product or codeset, such as the repair code or labor code. This object is available in API version 58.0 and later. - **[WorkOrderDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_workorderdiagnosis.htm)** Represents the diagnosis details of the Work Order that the user records during depot repair. # Manufacturing Cloud Tooling API Objects Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. For more information about Tooling API objects and to find a complete reference of all the supported objects, see **[Introducing Tooling API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/intro_api_tooling.htm)**. - **[AccountForecastSettings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_accountforecastsettings_tooling_api.htm)** Represents settings that define the generation of account forecasts and their display on the account’s record page. These settings also define the periods during which the account forecast values can be edited and the formula definitions for account forecast calculations. Available in API version 47.0 and later. - **[AcctMgrTargetSettings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_acctmgrtargetsettings_tooling_api.htm)** Represents the settings of account manager targets. These settings define the distribution frequency, the hierarchy of team members for assignments, and the default price book of account manager targets. This object also displays the record usage details by account manager targets in your Salesforce org. This object is available in API version 49.0 and later. - **[RecordActionDeployment](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_tooling_api_recordactiondeployment.htm)** Represents configuration settings for the Actions & Recommendations and Action Launcher components. RecordActionDeployment is available in API version 45.0 and later. - **[SalesAgreementSettings](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/mfg_salesagreementsettings_tooling_api.htm)** Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements. Available in API version 57.0 and later. # ManufacturingProgram Represents information about a manufacturing program. For example, Verican X program for Verican Account to manufacture auto components for their upcoming concept vehicle, staring from 01-Jan-2022 and valid until 01-Dec-2024. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account for which the manufacturing program is created. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the manufacturing program. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the manufacturing program. ### ExternalName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name used for the manufacturing program by external organizations. ### ManufacturingProgramTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The template used for the manufacturing program. This is a relationship field. - **Relationship Name**: ManufacturingProgramTemplate - **Relationship Type**: Lookup - **Refers To**: MfgProgramTemplate ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the manufacturing program record. ### ProgramType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of manufacturing program. ### RelatedManufacturingProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Another manufacturing program associated with the manufacturing program. This is a relationship field. - **Relationship Name**: RelatedManufacturingProgram - **Relationship Type**: Lookup - **Refers To**: ManufacturingProgram ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the manufacturing program. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the manufacturing program. - **Default value**: Draft - **Possible values**: - Active - Draft - Inactive # Mass Update Account Forecast Action Mass update account forecast fields for different products and periods with this single action. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note These actions update the forecast data in your Salesforce org. You must perform a database rollback to undo these actions. This object is available in API version 48.0 and later for users with Manufacturing Cloud license. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/massUpdateAccountForecast **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs | Input | Type | Description | | --- | --- | --- | | entityId | string | The ID of the forecast to mass update. | | fieldToUpdate | string | The developer name of an account product period forecast. For example, ForecastedQuantity | | periods | anyType | Comma-separated list of period IDs. | | products | anyType | Comma-separated list of account forecast product IDs. | | operation | string | Operation for mass update. Valid values are IncreaseBy DecreaseBy ReplaceWith. | | numericvalue | double | Numeric value to use in the operation for mass update. Can be any number up to 15 digits. | | numericValueType | string | Type of operation for mass update. Valid values are Percentage Absolute. | | adjNote | string | Any comments on the mass update operation. | ## Usage **Sample Request** The following example shows how to mass update forecast fields: { “entityId”: “a07B0000007qbQOIAY”, “fieldToUpdate”: “DiscountPercentage”, “periods”: “\[”a07B0000007qbQOIAY“,”a07B0000007qbQOIAY“\]”, “products”: “\[”a07B0000007qbQOIAY“,”a07B0000007qbQOIAY“\]”, “operation”: “ReplaceWith”, “numericvalue”: 10, “numericValueType”: “Percentage”, “adjNote”: “Percentage updated.” } # Mass Update Advance Account Forecast Action Update a measure of AdvAccountForecastFact records based on filter condition of the selected list view. For more information about how the massUpdateAdvAccountForecast action calculates the advanced account forecasting, see [Use Manufacturing Actions in Flow Builder and Process Builder](https://help.salesforce.com/s/articleView?id=ind.admin_manufacturing_standard_invocable_actions.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This action is available in API version 56.0 and later. To use this resource, you must have the Manufacturing Cloud and Advance Account Forecasting feature are enabled in your Salesforce org. See [Enable Advanced Account Forecasting](https://help.salesforce.com/s/articleView?id=sf.aaf_admin_enable.htm&language=en_US). ## Special Access Rules ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/massUpdateAdvAccountForecast **Formats:** JSON, XML **HTTP Methods:** POST **Authentication:** Authorization: Bearer token ## Inputs
Input Type Description
actionType String Required.

The type of action to be performed on the selected measure. Valid values are:

  • DecreaseBy
  • IncreaseBy
  • ReplaceWith
forecastReferenceId String Required.

The ID of the advanced account forecast set use record or advanced account forecast set partner record to be updated.
isPercent Boolean Required.

Specifies whether the values are a percentage (true) or not (false).

The default value is false.
listViewId String Required.

The ID of the list view record that contains the filtered forecast fact records to be updated.
measureFieldName String Required.

The API name of a measure field on the list view object to be updated in the forecast records.
value String Required.

The value to use to update the measure.
## Outputs | Output | Type | Description | | --- | --- | --- | | errors | List | A list of error messages if the operation fails. | | isSuccess | Boolean | Indicates whether the operation is successful or not. | ## Examples **Sample Request** {"inputs" : \[{ "actionType": "Increase By", "forecastReferenceId": "0ogT10000000BekIAE", "isPercent": false, "listViewId": "00BT1000000WIUxMAO", "measureFieldName": "custom\_measure\_\_c", "value": "1" }\]} **Sample Response** \[ { "actionName" : "massUpdateAdvAccountForecast", "errors" : null, "isSuccess" : true } \] # Mass Update Sales Agreement Action Now you can make mass updates to sales agreement fields for different products and periods with a single action. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note These actions update the sales agreement based data in your Salesforce org. You must perform a database rollback to undo these actions. This object is available in API version 48.0 and later for users with Manufacturing Cloud license. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/massUpdateSalesAgreement **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs
Input Type Description
entityId string The ID of the sales agreement to mass update.
fieldToUpdate string The developer name of a sales agreement product schedule field. For example, SalesPrice.
periods anyType List of sales agreement product schedules in the yyyy-MM-dd date format. For example, 2020-01-01,2020-02-01.
products anyType Comma separated list of sales agreement product IDs.
operation string Operation for mass update.

Valid values are:

  • Increase By
  • Decrease By
  • Replace With
numericvalue double Numeric value to use in the operation for mass update. Can be any number up to 15 digits.
numericValueType string Type of operation for mass update.

Valid values are:

  • percentage
  • absolute
## Usage **Sample Request** The following example shows how to mass update sales agreement fields: { "inputs": \[ { "entityId": "0YALT000000H9rh4AC", "products": \[ "0YBLT0000000Mq94AE" \], "periods": \[ "ALL" \], "fieldToUpdate": "SalesPrice", "operation": "Increase By", "numericValue": "15", "numericValueType": "absolute" } \] } # MfgPgmCpntFrcstFactOpptySchd Represents a junction between the forecast and opportunity line item schedule objects, providing details on the relationship between forecast data and corresponding sales order schedules. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ManufacturingProgramComponentForecastFact - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents information about the generated manufacturing program forecast records. ### OpportunityLineItemSchedule - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem - **Relationship Type**: Lookup - **Refers To**: OpportunityLineItemSchedule ### OpportunityLineItem - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents an opportunity line item associated with an Opportunity. - **Relationship Type**: Lookup - **Refers To**: OpportunityLineItem ### Opportunity - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents an opportunity, which is a sale or pending deal. - **Relationship Type**: Lookup - **Refers To**: Opportunity ### Product - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents Product on fact that is being converted to Oppotunity Line item - **Relationship Type**: Lookup - **Refers To**: Product2 # MfgProgramCpntFrcstFact Represents information about the generated manufacturing program component forecast records. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdjustedForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The adjusted value of the forecasted quantity. ### AdjustedForecastedRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The adjusted value of the forecasted revenue. ### AdvAcctForecastSetUseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The advanced account forecast set context associated with the manufacturing program component forecast fact record. This is a relationship field. - **Relationship Name**: AdvAcctForecastSetUse - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastSetUse ### CostUnitOfMeasurementId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This is a relationship field. - **Relationship Name**: CostUnitOfMeasurement - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### ExpectedProfitPerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected profit per unit from the product variant component. ### ExpectedProfitPercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected profit from the product variant component in percent. ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The external identifier for the manufacturing program component forecast fact record. ### ForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecasted quantity of the product variant component that’s calculated by multiplying the forecasted quantity of the associated manufacturing program with the number of component units per product variant unit. ### ForecastedRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecasted revenue from the product variant component. ### ManufacturingProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program associated with the manufacturing program product variant component forecast fact record. This is a relationship field. - **Relationship Name**: ManufacturingProgram - **Relationship Type**: Lookup - **Refers To**: ManufacturingProgram ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Manufacturing Program Component Forecast Fact record. ### PeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The period associated with the manufacturing program product variant component forecast fact record. This is a relationship field. - **Relationship Name**: Period - **Relationship Type**: Lookup - **Refers To**: Period ### PeriodStartDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The start date of the period for which the manufacturing program component forecast fact records are generated. ### ProductComponentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The component of the product variant that’s associated with the manufacturing program product variant component forecast fact record. This is a relationship field. - **Relationship Name**: ProductComponent - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program product associated with the manufacturing program product component forecast fact record. This is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductionLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production location of the account. This is a relationship field. - **Relationship Name**: ProductionLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ProductionModelId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model associated with the manufacturing program component forecast fact record. This is a relationship field. - **Relationship Name**: ProductionModel - **Relationship Type**: Lookup - **Refers To**: Product2 ### SellingPricePerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The selling price of a unit of the product variant component. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the manufacturing program product variant component forecast fact record. - **Default value**: Inactive - **Possible values**: - Active - Inactive ### TotalCostPerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total cost of a unit of the product variant component that's calculated by adding the total fixed cost per unit and the variable cost per unit. ### TotalFixedCostPerUnit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total fixed cost of a unit of the product variant component. ### VariableCostPerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The variable cost of a unit of the product variant component. # MfgProgramForecastFact Represents information about the generated manufacturing program forecast records. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdjustedForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The adjusted value of the forecasted quantity. ### AdjustedForecastedRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The adjusted value of the forecasted revenue. ### AdvAcctForecastSetUseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The advanced account forecast set context associated with the manufacturing program forecast fact record. This is a relationship field. - **Relationship Name**: AdvAcctForecastSetUse - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastSetUse ### ExpectedRevenuePerUnit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected revenue per unit of the product. ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The external identifier for the manufacturing program forecast fact record. ### ForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecasted quantity of the product associated with the manufacturing program that’s calculated by multiplying the product quantity with the market share percentage. ### ForecastedRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecasted revenue of the manufacturing program that’s calculated by multiplying the forecasted quantity with the market share percentage. ### ManufacturingProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program associated with the manufacturing program forecast fact record. This is a relationship field. - **Relationship Name**: ManufacturingProgram - **Relationship Type**: Lookup - **Refers To**: ManufacturingProgram ### MarketSharePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The market share of the total number of product units in percent. For example, if an OEM is planning to manufacture 10,000 cars of the ABC model in December 2021 and 25% will be manufactured at plant XYZ, 25% is the market share. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the manufacturing program forecast fact record. ### PeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The calendar period associated with the manufacturing program forecast fact record. This is a relationship field. - **Relationship Name**: Period - **Relationship Type**: Lookup - **Refers To**: Period ### PeriodStartDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The start date of the period for which the manufacturing program forecast fact records are generated. ### PreviousPeriodProgramQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The product quantity in the previous period. ### ProductionLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production location of the account. This is a relationship field. - **Relationship Name**: ProductionLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ProductionModelId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production model associated with the manufacturing program forecast fact record. This is a relationship field. - **Relationship Name**: ProductionModel - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProgramQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of units of the product that is manufactured as part of the program. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the manufacturing program forecast fact record. - **Default value**: Inactive - **Possible values**: - Active - Inactive # MfgProgramTemplate Represents information about the templates associated with a manufacturing program. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the manufacturing program template. ### ProgramTemplateName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique identifier for the manufacturing program template. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the manufacturing program template. - **Default value**: Active - **Possible values**: - Active - Draft - Inactive ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[MfgProgramTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[MfgProgramTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[MfgProgramTemplateOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner."):** Sharing rules are available for the object. **[MfgProgramTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # MfgProgramTemplateItem Represents information about the transformation type associated with a manufacturing program template. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AdvAccountForecastSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The forecast set associated with the transformation. This is a relationship field. - **Relationship Name**: AdvAccountForecastSet - **Relationship Type**: Lookup - **Refers To**: AdvAccountForecastSet ### ContextDefinition - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context definition that defines how data is mapped and transformed to the target object, such as an opportunity or account. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the manufacturing program template item. ### MfgProgramTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The manufacturing program template associated with the template item. This is a relationship field. - **Relationship Name**: MfgProgramTemplate - **Relationship Type**: Lookup - **Refers To**: MfgProgramTemplate ### SourceContextMappingName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context mapping that defines how data is mapped from a list of facts(Input Data) to create structured information. ### TargetContextMappingName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context mapping that defines how the structured data is saved to the target object, such as an opportunity or sales agreement. ### TemplateItemName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the manufacturing program template item. ### TransformationDisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The display order of the transformation in the manufacturing program template. ### TransformationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of transformation. - **Possible values**: - BusinessTransformation - ForecastSetRelation # MfgProgramVariantFrcstFact Represents information about the generated manufacturing program product variant forecast records. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdjustedForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The adjusted value of the forecasted quantity. ### AdvAcctForecastSetUseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The advanced account forecast set context associated with the manufacturing program variant forecast fact record. This is a relationship field. - **Relationship Name**: AdvAcctForecastSetUse - **Relationship Type**: Lookup - **Refers To**: AdvAcctForecastSetUse ### ExternalReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The external identifier for the manufacturing program variant forecast fact record. ### ForecastedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The forecasted quantity of the product variant that’s calculated by multiplying the forecasted quantity of the associated manufacturing program with the variant’s market share percentage. ### ManufacturingProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program associated with the manufacturing program product variant forecast fact record. This is a relationship field. - **Relationship Name**: ManufacturingProgram - **Relationship Type**: Lookup - **Refers To**: ManufacturingProgram ### MarketSharePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The market share of the total number of variant product units in percent. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the manufacturing program variant forecast fact record. ### PeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The calendar period associated with the manufacturing program product variant forecast fact record. This is a relationship field. - **Relationship Name**: Period - **Relationship Type**: Lookup - **Refers To**: Period ### PeriodStartDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The start date of the period for which the manufacturing program product variant forecast fact records are generated. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product variant associated with the manufacturing program product variant forecast fact record. This is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductionLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production location of the account. This is a relationship field. - **Relationship Name**: ProductionLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ProductionModelId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model associated with the manufacturing program variant forecast fact record. This is a relationship field. - **Relationship Name**: ProductionModel - **Relationship Type**: Lookup - **Refers To**: Product2 ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the manufacturing program product variant forecast fact record. - **Default value**: Inactive - **Possible values**: - Active - Inactive # Object Details Output Represents the details of the transformation object. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorReason | String | Indicates the reason for transformation failure. | Small, 55.0 | 55.0 | | inputIds | String\[\] | The record IDs of the input object corresponding to the output object. | Small, 55.0 | 55.0 | | isSuccess | Boolean | Indicates if the transformation is successful (true) or not (false). | Small, 55.0 | 55.0 | | outputId | String | The output record ID. | Small, 55.0 | 55.0 | # OpportunityPreferredSeller Represents the relationship between an opportunity and a dealer account, or the relationship between an opportunity and the account that provided the lead from which the opportunity was created. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated Account record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AccountRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The role of the Account in relation to the associated Opportunity, such as the opportunity's preferred dealer, or the lead provider. - **Possible values**: - DataProvider—Data Provider - Dealer ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated Contact record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the opportunity preferred seller. ### OpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated Opportunity record. This field is a relationship field. - **Relationship Name**: Opportunity - **Relationship Type**: Lookup - **Refers To**: Opportunity ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[OpportunityPreferredSellerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm):** Change events are available for the object. **[OpportunityPreferredSellerFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm):** Feed tracking is available for the object. **[OpportunityPreferredSellerHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # Pagination Meta Pagination metadata for the API responses. ## JSON Example { "pageNumber": 1, "pageSize": 10, "hasNext": false } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | hasNext | Boolean | Whether the next page is present for the response. | Big, 66.0 | 66.0 | | pageNumber | Integer | The page number of the response. | Big, 66.0 | 66.0 | | pageSize | Integer | The page size of the response. | Big, 66.0 | 66.0 | # Penny Perfect Pricing in Manufacturing Cloud Get instant pricing for advanced order line items based on the pricing data that you set up, and flatten account hierarchies for reporting and analytics. For more information about Penny Perfect Pricing, see the [Penny Perfect Pricing Developer Guide](https://developer.salesforce.com/docs/industries/penny-perfect-pricing/overview). # Process Additional Transaction (POST) Processes additional transactions for product items in manual synchronization scenarios. ## Resource /connect/inventory/process-additional-transaction ## Resource Example https://yourInstance.salesforce.com/services/data/v67.0/connect/inventory/process-additional-transaction ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productItemIds": \[ "sample-product-item-id-1", "sample-product-item-id-2" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productItemIds | String\[\] | List of product item IDs for which additional transactions need to be processed. | Required | 67.0 | ## Response Body for POST [Process Addl Txn Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_process_addl_txn_output.htm "Result of the additional product item transaction process.") # Process Addl Txn Input Input for processing additional product item transactions. ## JSON Example { "productItemIds": \[ "sample-product-item-id-1", "sample-product-item-id-2" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productItemIds | String\[\] | List of product item IDs for which additional transactions need to be processed. | Required | 67.0 | # Process Addl Txn Output Result of the additional product item transaction process. ## JSON Example { "isSuccess": true, "processedProductItemIds": \["sample-product-item-id-1", "sample-product-item-id-2"\], "unprocessedProductItemIds": \[\], "errorCode": "", "errorMessage": "" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | The error code if the request or process fails. | Big, 67.0 | 67.0 | | errorMessage | String | The detailed error message describing the failure. | Big, 67.0 | 67.0 | | isSuccess | Boolean | Indicates whether the transaction process was successful. | Big, 67.0 | 67.0 | | processedProductItemIds | String\[\] | List of product item IDs that were successfully processed. | Big, 67.0 | 67.0 | | unprocessedProductItemIds | String\[\] | List of product item IDs that could not be processed. | Big, 67.0 | 67.0 | # ProdtSvcCmpnDefPtnrInv Represents information about the partner-held inventory of the items that are impacted by a product service campaign. Stores the granular details, such as inventory status and impacted unit count, facilitating simplified tracking and efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InventoryStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of inventory at each partner location. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign definition partner inventory. ### PartnerAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the product service campaign definition partner inventory. This field is a relationship field. - **Relationship Name**: PartnerAccount - **Refers To**: Account ### PartnerType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of the partner associated with a product service campaign, such as a distributor or a dealer. ### PointOfContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The point of contact for the partner associated with a product service campaign. This field is a relationship field. - **Relationship Name**: PointOfContact - **Refers To**: Contact ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unsold inventory of the partner associated with a product service campaign. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductSvcCampaignDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign definition associated with the product service campaign definition partner inventory. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignDef (the master object) ### UnsoldInventoryQuantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of unsold and impacted inventory units. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnDefPtnrInvChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnDefPtnrInvHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProdtSvcCmpnDefRelaCausalItm Represents information about the cause associated with a product service campaign definition. Helps to efficiently identify and map faulty parts to the products that need to be repaired or replaced through the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign definition related causal item. ### ProdtSvcCmpnGrpDefCausalItmId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product service campaign group definition cause associated with the product service campaign definition related causal item. This field is a relationship field. - **Relationship Name**: ProdtSvcCmpnGrpDefCausalItm - **Refers To**: ProdtSvcCmpnGrpDefCausalItm ### ProductSvcCampaignDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign definition associated with the product service campaign definition related causal item. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignDef (the master object) ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnDefRelaCausalItmChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnDefRelaCausalItmHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProdtSvcCmpnGrpDefCausalItm Represents information about the impacted item that caused the service campaign to be initiated, such as an airbag that needs to be repaired or replaced. Stores the granular details related to the causal item, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BusinessBrandId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the business brand on the product record related to the product service campaign group definition causal item. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the product service campaign group definition causal item. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MakeName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the make name on the product record related to the product service campaign group definition causal item. ### ModelName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model name on the product record related to the product service campaign group definition causal item. ### ModelYear - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model year on the product record related to the product service campaign group definition causal item. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign group definition causal item. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The faulty product that is the cause of a product service campaign. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductSvcCampaignGrpDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign group definition associated with the product service campaign group definition causal item. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignGrpDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignGrpDef (the master object) ### RemediationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The remediation plan for a product service campaign, such as replacement or repair. - **Possible values**: - Notation - Repair - Replace ### ReplacementRqstType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of replacement requested for a product service event, such as product return for credit or receiving credit without returning the product. - **Possible values**: - RequestACreditWithoutProductReturn—Choose the ‘Request a Credit without Product Return’ option to scrap the causal parts without returning them and still receive credit from your supplier or original equipment manufacturer - RequestAProductReturnWithCredit—Choose the ‘Request a Product Return with Credit’ option to return causal parts to your supplier or original equipment manufacturer and receive credit from them ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnGrpDefCausalItmChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnGrpDefCausalItmHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProdtSvcCmpnGrpDefPtnr Represents information about the coordinating partner, such as a supplier or a distributor, that needs to be communicated regarding a particular product service campaign. Stores the granular details related to the partner, such as the channel of communication with them, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated account of the partner. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### EngagementChannelTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel of communication with the partner. This field is a relationship field. - **Relationship Name**: EngagementChannelType - **Refers To**: EngagementChannelType ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign group definition partner. ### PointOfContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The point of contact for the partner. This field is a relationship field. - **Relationship Name**: PointOfContact - **Refers To**: Contact ### ProductSvcCampaignGrpDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign group definition associated with the product service campaign group definition partner. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignGrpDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignGrpDef (the master object) ### RelatedRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated product service campaign definition and product service campaign group definition cause records. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Refers To**: ProdtSvcCmpnGrpDefCausalItm, ProductSvcCampaignDef ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of the partner, such as a manufacturer, supplier, or dealer. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnGrpDefPtnrChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnGrpDefPtnrHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProdtSvcCmpnPreferredPartner Represents information about the most appropriate partner to execute a product service campaign within a specific geographic area. Helps to map and allocate service providers to minimize costs and turnaround time,facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the product service campaign preferred partner. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The point of contact for the product service campaign preferred partner. This field is a relationship field. - **Relationship Name**: Contact - **Refers To**: Contact ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location of the product service campaign preferred partner. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign preferred partner. ### PartnerPrefOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order of preference for the product service campaign preferred partner. ### ProductServiceCampaignId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign associated with the product service campaign preferred partner. This field is a relationship field. - **Relationship Name**: ProductServiceCampaign - **Relationship Type**: Master-detail - **Refers To**: ProductServiceCampaign (the master object) ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of the product service campaign preferred partner, such as a supplier. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnPreferredPartnerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnPreferredPartnerHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProdtSvcCmpnWorkType Represents information about the eligible work types that can be associated with a product service campaign. Helps to identify and track the work types related to the impacted items, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign work type. ### ProductServiceCampaignId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign associated with the product service campaign work type. This field is a relationship field. - **Relationship Name**: ProductServiceCampaign - **Relationship Type**: Master-detail - **Refers To**: ProductServiceCampaign (the master object) ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The work type associated with the product service campaign work type. This field is a relationship field. - **Relationship Name**: WorkType - **Refers To**: WorkType ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProdtSvcCmpnWorkTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProdtSvcCmpnWorkTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # Product Requirement Specification Error Error representation for Product Requirement Specification operations. ## JSON Example { "requestUniqueId": "req-12345-abcde", "status": "ERROR", "message": "Validation failed for Product Requirement Specification", "details": \[ { "field": "name", "message": "Name is required and cannot be empty", "code": "REQUIRED\_FIELD\_MISSING" }, { "field": "accountId", "message": "Invalid Account ID format", "code": "INVALID\_ID\_FORMAT" } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | details | [Product Requirement Specification Error Detail](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_error_detail.htm "Error representation for Product Requirement Specification operations. Null if the operation was successful.")\[\] | A list of specific errors that occurred | Small, 66.0 | 66.0 | | message | String | A high-level message describing the error | Small, 66.0 | 66.0 | | requestUniqueId | String | The unique ID from the request, used for tracing | Small, 66.0 | 66.0 | | status | String | The status of the operation | Small, 66.0 | 66.0 | # Product Requirement Specification Error Detail Error representation for Product Requirement Specification operations. Null if the operation was successful. ## JSON Example { "field": "name", "message": "Name is required and cannot be empty", "code": "REQUIRED\_FIELD\_MISSING" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | An error code identifying the issue | Small, 66.0 | 66.0 | | field | String | The API name of the field that caused the error, if applicable | Small, 66.0 | 66.0 | | message | String | A description of the error | Small, 66.0 | 66.0 | # Product Requirement Specification Input Input representation for the Product Requirement Specification data to process. ## JSON Example { "properties": { "properties": \[ { "field": "Name", "value": "Advanced Component Specification" }, { "field": "Category", "value": "Electronics" }, { "field": "Priority", "value": "High" } \] }, "productRequirementSpecificationVersions": { "productRequirementSpecificationVersions": \[ { "properties": { "properties": \[ { "field": "VersionNumber", "value": "2.0" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productRequirementSpecificationVersions | [Product Requirement Specification Version Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_version_input.htm "Input representation for a list of specification versions, including version data and associated items.") | A list of specification versions, including version data and associated items. | Optional | 66.0 | | properties | Property\[[PropertiesListWrapperInput](#PropertiesListWrapperInput)\] | A list of key-value pairs for the specification's fields. | Required | 66.0 | ## PropertiesListWrapperInput A list of key-value pairs. ## JSON Example { "properties": \[ { "field": "Name", "value": "Advanced Component Specification" }, { "field": "Category", "value": "Electronics" }, { "field": "Priority", "value": "High" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | The API name of the field. | Required | 66.0 | | value | String | The value for the specified field. | Required | 66.0 | # Product Requirement Specification Item Input Input representation of a list of items associated with this version. ## JSON Example { "properties": { "properties": \[ { "field": "ItemType", "value": "Quality Check" }, { "field": "TestMethod", "value": "Visual Inspection" }, { "field": "AcceptanceCriteria", "value": "No visible defects" }, { "field": "SamplingSize", "value": "100" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | properties | [Property](#PropertiesListWrapperInput)\[PropertiesListWrapperInput\] | A list of key-value pairs for the specification's fields | | 66.0 | ## PropertiesListWrapperInput A list of key-value pairs. ## JSON Example { "properties": \[ { "field": "VersionNumber", "value": "3.5" }, { "field": "VersionName", "value": "Q1 2025 Release" }, { "field": "ApprovalStatus", "value": "Pending" }, { "field": "ApprovedBy", "value": "John Doe" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | The API name of the field. | Required | 66.0 | | value | String | The value for the specified field. | Required | 66.0 | # Product Requirement Specification Item Output Output representation of the list of items for this specification version. ## JSON Example { "id": "0Do5g000000MpQ5CAK", "name": "Tablet Weight Specification", "ownerId": "0055g000005OsYnAAK", "productRqmtSpecVersionId": "0Dn5g000000LmN4CAK", "category": "Physical", "statement": "Each tablet must weigh between 495mg and 505mg", "acceptanceCriteria": "100% of tablets must fall within specified weight range during quality control sampling", "targetValue": "500", "tolerance": "5", "unitOfMeasureId": "UoM5g000000AbCdEFG", "verificationMethod": "Analytical balance with 0.1mg precision", "riskLevel": "High", "additionalInfo": "Weight verification required every 30 minutes during production", "createdById": "0055g000005OsYnAAK", "lastModifiedById": "0055g000005OsYnAAK", "createdDate": "2024-01-15T10:30:00.000Z", "lastModifiedDate": "2024-01-20T14:45:00.000Z", "customAttributes": "{"testFrequency": "Every 30 minutes", "sampleSize": "20 tablets"}" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | acceptanceCriteria | String | The measurable conditions for requirement fulfillment. | Small, 66.0 | 66.0 | | additionalInfo | String | Additional notes or instructions for this item. | Small, 66.0 | 66.0 | | category | String | The type of requirement, such as Functional or Performance. | Small, 66.0 | 66.0 | | createdById | String | The ID of the user who created the item. | Small, 66.0 | 66.0 | | createdDate | String | The creation date and time of the item. | Small, 66.0 | 66.0 | | customAttributes | String | A JSON string containing custom fields and their values. | Small, 66.0 | 66.0 | | id | String | The ID of the specification item. | Small, 66.0 | 66.0 | | lastModifiedById | String | The ID of the user who last modified the item. | Small, 66.0 | 66.0 | | lastModifiedDate | String | The last modified date and time of the item. | Small, 66.0 | 66.0 | | name | String | The name of the specification item. | Small, 66.0 | 66.0 | | ownerId | String | The ID of the user who owns the item. | Small, 66.0 | 66.0 | | productRqmtSpecVersionId | String | The ID of the parent specification version. | Small, 66.0 | 66.0 | | riskLevel | String | The criticality of this requirement. | Small, 66.0 | 66.0 | | statement | String | A detailed, testable statement of the requirement. | Small, 66.0 | 66.0 | | targetValue | String | The specific, desired value for this requirement. | Small, 66.0 | 66.0 | | tolerance | String | The acceptable range of deviation from the target value. | Small, 66.0 | 66.0 | | unitOfMeasureId | String | The ID of the unit of measure for the target value and tolerance. | Small, 66.0 | 66.0 | | verificationMethod | String | The method used to validate this requirement. | Small, 66.0 | 66.0 | # Product Requirement Specification Output Output representation of the resulting Product Requirement Specification data. ## JSON Example { "id": "0Dm5g000000KyZ3CAK", "name": "Pharmaceutical Grade Tablet Specification", "ownerId": "0055g000005OsYnAAK", "accountId": "0015g000005TjklAAC", "contactId": "0035g000005UmnoPQR", "status": "Active", "origin": "Customer Request", "priority": "High", "stage": "In Review", "latestVersionId": "0Dn5g000000LmN4CAK", "createdById": "0055g000005OsYnAAK", "lastModifiedById": "0055g000005OsYnAAK", "createdDate": "2024-01-15T10:30:00.000Z", "lastModifiedDate": "2024-01-20T14:45:00.000Z", "customAttributes": "{"regulatoryCompliance": "FDA", "productLine": "Healthcare"}", "productRequirementSpecificationVersions": \[ { "id": "0Dn5g000000LmN4CAK", "name": "Version 1.0", "version": 1 } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accountId | String | The ID of the associated customer account. | Small, 66.0 | 66.0 | | contactId | String | The ID of the contact at the associated account. | Small, 66.0 | 66.0 | | createdById | String | The ID of the user who created the specification. | Small, 66.0 | 66.0 | | createdDate | String | The creation date and time of the specification. | Small, 66.0 | 66.0 | | customAttributes | String | A JSON string containing custom fields and their values. | Small, 66.0 | 66.0 | | id | String | The ID of the Product Requirement Specification. | Small, 66.0 | 66.0 | | lastModifiedById | String | The ID of the user who last modified the specification. | Small, 66.0 | 66.0 | | lastModifiedDate | String | The last modified date and time of the specification. | Small, 66.0 | 66.0 | | latestVersionId | String | The ID of the latest version of the specification. | Small, 66.0 | 66.0 | | name | String | The name of the Product Requirement Specification. | Small, 66.0 | 66.0 | | origin | String | The source that initiated the requirement. | Small, 66.0 | 66.0 | | ownerId | String | The ID of the user who owns the specification. | Small, 66.0 | 66.0 | | priority | String | The priority of the requirement. | Small, 66.0 | 66.0 | | productRequirementSpecificationVersions | [Product Requirement Specification Version Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_version_output.htm "Output representation of the list of versions for this specification.")\[\] | A list of versions for this specification. | Small, 66.0 | 66.0 | | stage | String | The current stage of the specification in its workflow. | Small, 66.0 | 66.0 | | status | String | The current status of the specification. | Small, 66.0 | 66.0 | # Product Requirement Specification Version Input Input representation for a list of specification versions, including version data and associated items. ## JSON Example { "properties": { "properties": \[ { "field": "VersionNumber", "value": "3.5" }, { "field": "VersionName", "value": "Q1 2025 Release" }, { "field": "ApprovalStatus", "value": "Pending" }, { "field": "ApprovedBy", "value": "John Doe" } \] }, "productRequirementSpecificationItems": { "productRequirementSpecificationItems": \[ { "properties": { "properties": \[ { "field": "TestCriteria", "value": "ISO-9001 Compliance" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productRequirementSpecificationItems | [Product Requirement Specification Item Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_item_input.htm "Input representation of a list of items associated with this version.") | A list of items associated with this version. | Optional | 66.0 | | properties | [PropertiesListWrapperInput](#PropertiesListWrapperInput) | A list of key-value pairs for the version's fields. | Required | 66.0 | ## PropertiesListWrapperInput A list of key-value pairs. ## JSON Example { "properties": \[ { "field": "VersionNumber", "value": "3.5" }, { "field": "VersionName", "value": "Q1 2025 Release" }, { "field": "ApprovalStatus", "value": "Pending" }, { "field": "ApprovedBy", "value": "John Doe" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | The API name of the field. | Required | 66.0 | | value | String | The value for the specified field. | Required | 66.0 | # Product Requirement Specification Version Output Output representation of the list of versions for this specification. ## JSON Example { "id": "0Dn5g000000LmN4CAK", "name": "Tablet Specification v2.0", "ownerId": "0055g000005OsYnAAK", "productRqmtSpecId": "0Dm5g000000KyZ3CAK", "version": 2, "purpose": "Define specifications for manufacturing pharmaceutical tablets meeting FDA standards", "intendedUse": "Manufacturing of pain relief tablets for consumer market", "scope": "Covers physical, chemical, and biological specifications for tablet production", "assumptions": "Standard manufacturing equipment available, controlled environment", "constraints": "Must comply with FDA regulations, production cost under $0.50 per unit", "verificationMethod": "Laboratory testing and statistical process control", "refProductId": "01t5g000005AbCdEFG", "refProductCategoryId": "0ZG5g000000PqRsSST", "effectiveDate": "2024-02-01T00:00:00.000Z", "expiryDate": "2025-02-01T00:00:00.000Z", "contentDocumentId": "069xx000000ABCDEAU", "additionalInfo": "Refer to attached technical drawings and material specifications", "createdById": "0055g000005OsYnAAK", "lastModifiedById": "0055g000005OsYnAAK", "createdDate": "2024-01-15T10:30:00.000Z", "lastModifiedDate": "2024-01-20T14:45:00.000Z", "customAttributes": "{"approvedBy": "Quality Assurance Team", "certificationNumber": "FDA-2024-001"}", "productRequirementSpecificationItems": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalInfo | String | Additional notes or instructions for this version. | Small, 66.0 | 66.0 | | assumptions | String | Conditions or beliefs assumed to be true for the design. | Small, 66.0 | 66.0 | | constraints | String | Limitations, such as cost or time, that must be met. | Small, 66.0 | 66.0 | | contentDocumentId | String | The ID of an attached document. | Small, 66.0 | 66.0 | | createdById | String | The ID of the user who created the version. | Small, 66.0 | 66.0 | | createdDate | String | The creation date and time of the version. | Small, 66.0 | 66.0 | | customAttributes | String | A JSON string containing custom fields and their values. | Small, 66.0 | 66.0 | | effectiveDate | String | The date this specification version becomes valid. | Small, 66.0 | 66.0 | | expiryDate | String | The date this specification version becomes obsolete. | Small, 66.0 | 66.0 | | id | String | The ID of the specification version. | Small, 66.0 | 66.0 | | intendedUse | String | The business or functional goal of the product. | Small, 66.0 | 66.0 | | lastModifiedById | String | The ID of the user who last modified the version. | Small, 66.0 | 66.0 | | lastModifiedDate | String | The last modified date and time of the version. | Small, 66.0 | 66.0 | | name | String | The name of the specification version. | Small, 66.0 | 66.0 | | ownerId | String | The ID of the user who owns the version. | Small, 66.0 | 66.0 | | productRequirementSpecificationItems | [Product Requirement Specification Item Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_item_output.htm "Output representation of the list of items for this specification version.")\[\] | A list of items for this specification version. | Small, 66.0 | 66.0 | | productRqmtSpecId | String | The ID of the parent specification. | Small, 66.0 | 66.0 | | purpose | String | The business reason for the requirement. | Small, 66.0 | 66.0 | | refProductCategoryId | String | The ID of the category for the reference product. | Small, 66.0 | 66.0 | | refProductId | String | The ID of a reference or baseline product. | Small, 66.0 | 66.0 | | scope | String | The defined boundaries for the product or project. | Small, 66.0 | 66.0 | | verificationMethod | String | The method used to confirm the requirement is met. | Small, 66.0 | 66.0 | | version | Integer | The version number. | Small, 66.0 | 66.0 | # ProductBatchItem Represents the details about the product items in each batch. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssigneeId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the user or group assigned to the product batch item. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: User ### ExpirationDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product batch item expires and is no longer usable. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the batch status is active (true) or not (false). - **Default value**: false ### IsProductionBatchActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the production batch associated with the product batch item is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location associated with the product batch item. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product batch item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the product batch item record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with the product batch item. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item associated with the product batch item. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The production batch associated with the product batch item. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity of the product batch item deducted through the web interface. - **Possible values**: - Each ### RemainingQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining quantity of product items in the product batch item. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductBatchItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProductBatchItemFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[ProductBatchItemHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[ProductBatchItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner."):** Sharing rules are available for the object. **[ProductBatchItemShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # ProductConsumed Represents an item from your product inventory that was used to complete a work order or work order line item. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product consumed record. ### Discount - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The discount on the product consumed. ### IsConsumed - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies that a product consumed has been consumed if the product it refers to is serialized. - **Default value**: false ### IsProduct2Serialized - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if the associated product that was consumed is a serialized product (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### ListPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The list price of the product. ### PricebookEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The price book associated with the product consumed. If the work order and the product item’s associated product are related to the same price book, the Price Book Entry auto-populates based on the product item. This field is a relationship field. - **Relationship Name**: PricebookEntry - **Relationship Type**: Lookup - **Refers To**: PricebookEntry ### Product2Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with the product consumed. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductConsumedNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number identifying the product consumed. ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The product item associated with the product consumed. This field is a relationship field. - **Relationship Name**: ProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the product that’s consumed. ### QuantityConsumed - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product that’s consumed. When you create a product consumed record, the quantity consumed is subtracted from the product item’s quantity. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit of the quantity of the product that’s consumed. For example, kilograms or liters. Quantity Unit of Measure values are inherited from the Quantity Unit of Measure field on products. - **Possible values**: - Each ### TotalPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The total price paid for the product items. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price per unit of the product consumed. ### WorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The work order for which the product was consumed. This field is a relationship field. - **Relationship Name**: WorkOrder - **Relationship Type**: Lookup - **Refers To**: WorkOrder ### WorkOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order line item for which the product was consumed. This field is a relationship field. - **Relationship Name**: WorkOrderLineItem - **Relationship Type**: Lookup - **Refers To**: WorkOrderLineIte # ProductConsumedState Represents an action taken to associate a serialized product with a product transfer. The new state is a result of the action. A product transfer state record is created when serialized products are attached to the product transfer. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product consumed state. ### ConsumedState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The state of the consumed product. ### ProductConsumedId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product consumed that’s associated with the product consumed state. This field is a relationship field. - **Relationship Name**: ProductConsumed - **Relationship Type**: Lookup - **Refers To**: ProductConsumed ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serialized product that’s associated with the product consumed state. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Relationship Type**: Lookup - **Refers To**: SerializedProduct # ProductFaultCode Represents a relationship between a product or product family and the fault code. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### FaultCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fault code associated with the product or product family. This field is a relationship field. - **Relationship Name**: FaultCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number for the name of the product fault code. ### ProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the product family associated with the fault code. - **Possible values**: - None ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product associated with the fault code. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 # ProductInventoryBatchSearchableField Represents production batch data used for inventory search, including batch item details for a specific location. This data serves as the basis for Criteria-Based and Filter Search, which combines batch details with standard inventory dimensions. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BatchUniqueIdentificationNumber - **Type**: text - **Properties**: Filter, Group, Sort - **Description**: The unique identification number of the batch. ### BatchItemRemainingQuantity - **Type**: double - **Properties**: Filter, Group, Sort - **Description**: The quantity of the product items remaining in the batch. ### Product2 - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product record associated with the record. ### ProductName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the product related to a product item. ### TotalQuantityUnitOfMeasure - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: Specifies the unit of measure for the total quantity at location. ### ProductItem - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item record associated with the record. ### BusinessBrand - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The business brand record associated with the record. ### BusinessBrandName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the business brand of a product item. ### MakeName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The make name of a product item. ### ModelName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The model name of a product item. ### ModelYear - **Type**: ind - **Properties**: Filter, Group, Sort - **Description**: The model year of a product item. ### ProductCode - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The product code for identifying a product item. ### IsBatchItemActive - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the product batch item status is active. ### IsProductSerialized - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the product related to a product item is a serialized product (true) or not (false). ### UniversalProductCode - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The universal product code that's used to track the product item. ### ManufacturerPartNumber - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The unique number assigned by the manufacturer to identify a product item. ### ProductName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the product related to a product item. ### ProductBatchItemAssignee - **Type**: reference - **Properties**: Create, Nillable, Update - **Description**: The assignee associated with the product batch item. ### ProductDescription - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The description of a product item. ### ProductFamily - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: Specifies the product family to which a product item belongs. ### ProductLineCode - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The product line category of a product item. ### ProductCategoryCode - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The product category code of a product item. ### ProductManufacturerName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the manufacturer that manufactured a product item. ### ProductVersionName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The version name of a product item. ### HarmonizedSystemCode - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The harmonized system code that's assigned to the product item. ### IsEnvrPrtcRegCompliant - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the product item is compliant with environment protection regulations (true) or not (false). ### InventoryLocation - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The location record associated with the record. ### InventoryLocationCoordinates - **Type**: location - **Properties**: Filter, Group, Sort - **Description**: The latitude and longitude of the inventory location. ### InventoryLocationName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name inventory location for a product item. ### InvLocationCoord - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The latitude and longitude coordinates of an inventory location for a product item. ### InventoryLocationType - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The type of an inventory location for a product item. ### ParentInventoryLocation - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The parent inventory location associated with the record. ### ParentInventoryLocationName - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The name of the parent inventory location for a product item. ### ParentInventoryLocationType - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The type of the parent inventory location for a product item. ### Account - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The account associated with the record. ### AccountName Batch - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the account related to a product item. ### ProductionBatch - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The batch associated with the product item record. ### BatchName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of batch related to a product item. ### BatchIdentificationNumber - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The unique identification number of the batch. ### BatchCreatedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the batch is created. ### BatchManufacturedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The manufactured date and time for the batch. ### BatchExpirationDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the batch expires. . ### BatchCreationLocation - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The batch creation location associated with the batch. ### BatchCreationLocationName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the location where the batch is created. ### BatchManufacturingLocation - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The manufacturing location record associated with the batch. ### BatchManufacturingLocationName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The manufacturing location of the batch. ### IsBatchActive - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the batch status is active(true) or not (false). ### BatchOriginType - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: Specifies the orgin type of the batch. ### ProductBatchItem - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product item associated with the batch. ### ProductBatchItemName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the product item associated with the batch. ### ProductBatchItemQuantity - **Type**: double - **Properties**: Filter, Group, Sort - **Description**: The quantity of the product items in the batch. ### IsProductBatchItemActive - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the product batch item status is active(true) or not (false). ### ProductBatchItemAssignee - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The assignee associated with the product batch item. ### ProductBatchItemAssigneeName - **Type**: text - **Properties**: Create, Nillable, Update - **Description**: The name of the assignee associated with the product batch item. ## Associated Object This object has the following associated object. Unless noted, it is available in the same API version as this object. **[AccountForecastChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. # ProductInvSearchableField Represents a dataset on inventory information that's the basis for searching product inventory. Contains multiple fields from Product Item and related objects. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the record. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AccountName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the account related to a product item. ### BusinessBrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business brand record associated with the record. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### BusinessBrandName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the business brand of a product item. ### ExcessQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The excess quantity for the product item. Calculated as the difference between the quantity on hand and the maximum inventory quantity. If the quantity on hand is less than the maximum, this value is 0. ### HarmonizedSystemCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The harmonized system code that's assigned to the product item. ### InvLocationCoord - **Type**: location - **Properties**: Nillable - **Description**: The location record associated with the record. ### InvLocationCoordLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude of the inventory location. ### InvLocationCoordLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude of the inventory location. ### InventoryLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location record associated with the record. This field is a relationship field. - **Relationship Name**: InventoryLocation - **Refers To**: Location ### InventoryLocationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name inventory location for a product item. ### InventoryLocationType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of an inventory location for a product item. ### InvReplenishmentPolicy - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The replenishment policy record associated with the product item. This field identifies the inventory replenishment rules that apply to the product item. - **Relationship Name**: InvReplenishmentPolicy - **Refers To**: InvReplenishmentPolicy ### InvReplenishmentPolicyName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the replenishment policy applicable to the product item. ### IsEnvrPrtcRegCompliant - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product item is compliant with environment protection regulations (true) or not (false). - **Default value**: false ### IsProductSerialized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product related to a product item is a serialized product (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MakeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The make name of a product item. ### ManufacturerPartNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique number assigned by the manufacturer to identify a product item. ### MinimumInventoryQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum inventory quantity specified in the replenishment policy. ### MaximumInventoryQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum inventory quantity specified in the replenishment policy. ### ModelName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model name of a product item. ### ModelYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The model year of a product item. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product related to a product item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentInventoryLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent inventory location associated with the record. This field is a relationship field. - **Relationship Name**: ParentInventoryLocation - **Refers To**: Location ### ParentInventoryLocationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the parent inventory location for a product item. ### ParentInventoryLocationType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the parent inventory location for a product item. ### ProductCategoryCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product category code of a product item. ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product code for identifying a product item. ### ProductDescription - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of a product item. ### ProductFamily - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the product family to which a product item belongs. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product record associated with the record. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product item record associated with the record. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductLineCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product line category of a product item. ### ProductManufacturerName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the manufacturer that manufactured a product item. ### ProductName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the product related to a product item. ### ProductVersionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version name of a product item. ### ReplenishmentLocation - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory location from which replenishment should be sourced, based on the criteria defined in the replenishment policy. - **Relationship Name**: ReplenishmentLocation - **Refers To**: Location ### ReplenishmentLocationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the replenishment source location derived from the replenishment policy criteria. ### ReplenishmentQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The suggested replenishment quantity for the product item, calculated based on the formula defined in the associated replenishment policy. ### ShortageQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity shortage for the product item. Calculated as the difference between the minimum inventory quantity and the quantity on hand. If the quantity on hand is greater than the minimum, this value is 0. ### StockStatus - **Type**: picklist - **Properties**: Filter, Nillable, Sort - **Description**: Indicates the stock status of the product item. - **Possible values**: - Shortage - In Range - Excess ### TotalQuantityAtLocation - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total quantity of a product item at an inventory location. ### TotalQuantityUnitOfMeasure - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the unit of measure for the total quantity at location. ### UniversalProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The universal product code that's used to track the product item. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductInvSearchableFieldShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # ProductionBatch Represents the batch of homogeneous products manufactured in the same production line. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BatchCreatedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the production batch is created. ### CreationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the location where the batch is created. This field is a relationship field. - **Relationship Name**: CreationLocation - **Refers To**: Location ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the production batch. ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the batch expires and is no longer usable. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the production batch is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### ManufacturedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The manufactured date and time for the production batch. ### ManufacturingLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the manufacturing location of the production batch. This field is a relationship field. - **Relationship Name**: ManufacturingLocation - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the production batch. ### OriginType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of origin of the batch. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the production batch. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the unit of measure for the products of the production batch. ### UniqueIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identification number of the production batch. This field is unique within your organization. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductionBatchChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProductionBatchFeed](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object."):** Feed tracking is available for the object. **[ProductionBatchHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. **[ProductionBatchOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner."):** Sharing rules are available for the object. **[ProductionBatchShare](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object."):** Sharing is available for the object. # ProductItem Represents the stock of a product at a particular inventory location, such as a warehouse or a distribution lot. Product item records represent your inventory. A product item is associated with an inventory location and stores the quantity of products at that location. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IsProduct2Serialized - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if the product associated with the product item is a serialized product (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The location that’s associated with the product item. This usually indicates where the product item is stored. This field is a relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the product item. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product that’s associated with the product item. This usually represents the type of product in your inventory. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number identifying the product item. ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the product item. We recommend you use a name that indicates the name of the product along with its location. ### QuantityOnHand - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity at the location. If you want to add a serial number, this value must be 1. ### QuantityAllocated - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product items that are allocated but not yet shipped.. ### QuantityAvailable - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product items that are currently available in inventory. ### QuantityDamaged - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product items that are damaged. ### QuantityInTransit - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product items that are currently in transit between locations. ### QuantityOrdered - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product items that are ordered from suppliers but not yet received. ### QtyStateRefreshDate - **Type**: datetime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the quantity status of the product item was last updated. The date only changes when the quantity status changes, not when the on-hand quantity changes. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the quantity of the product that’s consumed. For example, kilograms or liters. Quantity Unit of Measure values are inherited from the Quantity Unit of Measure field on products. - **Possible values**: - Each ### SerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A unique number for identification purposes. If you want to enter a serial number, the Quantity on Hand must be 1. # ProductItemAddlTrxn Represents an individual transaction that records a change in the state and quantity of a specific product item. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description for the additional transaction associated with the product item. ### ProductBatchItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product batch item associated with the record. This field is a relationship field. - **Relationship Name**: ProductBatchItem - **Refers To**: ProductBatchItem ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item associated with the record. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductItemState - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The state of the product item based on the transaction. - **Possible values**: - Allocated - Custom - Damaged - OnHand - Ordered ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of the product Item that's affected by the additional transaction. ### RelatedRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related entity record that represents the source of the transaction. This field is a relationship field. - **Possible values**: - OrderItem - Inventory Allocation - WorkOrderLineItem - ReturnOrderLineItem - PurchaseRequestLineItem - ProductTransfer - **Relationship Name**: RelatedRecord - **Refers To**: InventoryItemReservation, ProductTransfer, ReturnOrderLineItem ### TransactionDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time of the additional transaction for the product item. ### TransactionStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The processing status of the additional transaction. - **Default value**: Pending - **Possible values**: - Failure - Pending - Success ### TransactionStatusMessage - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The comments captured by the system while processing the additional transaction. ### TransactionType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The transaction type for the product item status transaction. - **Possible values**: - Adjusted - Allocated - Custom - Deallocated - Inbound Ordered - Order Canceled - Inbound Shipped - Order received ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductItemAddlTrxnOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountownersharingrule.htm):** Sharing rules are available for the object. # ProductItemTransaction Represents an action taken on a product item. Product item transactions track when a product is consumed, replenished, adjusted, or transferred. Product item transactions are auto-generated records that specify the quantity of products impacted by the action. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product item transaction. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product item associated with the product item transaction. This field is a relationship field. - **Relationship Name**: ProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### ProductItemTransactionNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number identifying the product item transaction. ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort - **Description**: The quantity of the product item involved in the transaction. If inventory was consumed, the quantity is negative. ### RelatedRecordId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product consumed, product transfer, or visit related to the action. If the action wasn’t related to consumption or transfer, the related record is blank. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Relationship Type**: Lookup - **Refers To**: ProductConsumed, ProductTransfer, Visit ### TransactionType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The action that the transaction tracks. - **Possible values**: - Adjusted - Consumed - Replenished - Transferred # ProductLaborCode Represents a junction between the labor code that's applicable to a product or product family and the required standard effort. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LaborCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The labor code associated with the product or product family. This field is a relationship field. - **Relationship Name**: LaborCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number for the name of the product labor code. ### ProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family associated with the labor code. - **Possible values**: - None # ProductRelatedMaterial Represents information about the components of a product. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the product component record. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when the product component is effective. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which the product component is effective. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LeadTime - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lead time required to manufacture the product component. ### LeadTimeUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the lead time. This is a relationship field. - **Relationship Name**: LeadTimeUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### ManufacturingProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program associated with the Product Related Material. This is a relationship field. - **Relationship Name**: ManufacturingProgram - **Relationship Type**: Lookup - **Refers To**: ManufacturingProgram ### MinimumEligibleQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum quantity of the product component that’s required to accept the deal. ### MinimumEligibleQuantityUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the minimum eligible quantity of the product component. This is a relationship field. - **Relationship Name**: MinimumEligibleQuantityUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the product component record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductComponentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier for the product component. This is a relationship field. - **Relationship Name**: ProductComponent - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductCpntPricebookId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The pricebook entry associated with the Product Related Material. This is a relationship field. - **Relationship Name**: ProductCpntPricebook - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the component. This is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### QuantityPerProductUnit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of units of the component required per unit of the product. ### QuantityUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the component quantity. This is a relationship field. - **Relationship Name**: QuantityUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### UsageCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of usage for the product component. # ProductRequest Represents a request or an order for products to and from specific inventory locations. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the product request. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the product request. For example, this may be the case because of which the product is requested. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product request. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the product is delivered. This field is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### NeedByDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date by which the product must be delivered to fulfill the request. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the product request. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductRequestNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number identifying the product request. ### ShipToAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address that the product is to be delivered to. ### ShipToCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city that the product is to be delivered to. ### ShipToCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country that the product is to be delivered to. ### ShipToGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The accuracy of the geocode for the shipping address. ### ShipToLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude of the location where the product is to be delivered to. ### ShipToLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude of the location where the product is to be delivered to. ### ShipToPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address where the product is to be delivered to. ### ShipToState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the state where the product is to be delivered to. ### ShipToStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street address where the product is to be delivered to. ### ShipmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of shipment. The picklist includes the following values by default: - None - Rush - Overnight - Next Business Day - Pick Up ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location from which the product is shipped. This field is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the product transfer. ### WorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order that’s associated with the product request. This field is a relationship field. - **Relationship Name**: WorkOrder - **Relationship Type**: Lookup - **Refers To**: WorkOrder ### WorkOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order line item that’s associated with the product request. This field is a relationship field. - **Relationship Name**: WorkOrderLineItem - **Relationship Type**: Lookup - **Refers To**: WorkOrderLineItem # ProductRequestLineItem Represents a product that’s requested as a part of a product request. Product request line items are components of product requests. Each line item is associated with a specific product being requested. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the product request line item. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the product request line item. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product request line item. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The destination of the product delivery. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### NeedByDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the product must be delivered by. ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product request that’s associated with the product request line item. This field is a relationship field. - **Relationship Name**: Parent - **Relationship Type**: Lookup - **Refers To**: ProductRequest ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the product request line item. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductRequestLineItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number for the product request line item. ### QuantityRequested - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of the requested product. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The units of the requested product; for example, grams, liters, or units. The picklist values can be customized. ### ShipToAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The physical address where the product is needed. ### ShipToCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the address where the product is needed. ### ShipToCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the address where the product is needed. ### ShipToGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the address where the product is needed. ### ShipToLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### ShipToLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### ShipToPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address where the product is needed. ### ShipToState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the address where the product is needed. ### ShipToStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the address where the product is needed. ### ShipmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of shipment. The picklist includes the following values, which can be customized: - Rush - Overnight - Next Business Day - Pick Up ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Where the product is at the time of the request. This is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the shipment. The picklist includes the following values, which can be customized: - Draft - Submitted - Received ### WorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order for which the product is needed. This is a relationship field. - **Relationship Name**: WorkOrder - **Relationship Type**: Lookup - **Refers To**: WorkOrder ### WorkOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order line item for which the product is needed. This is a relationship field. - **Relationship Name**: WorkOrderLineItem - **Relationship Type**: Lookup - **Refers To**: WorkOrderLineItem # ProductRequired Represents a product that is needed to complete a work order or work order line item. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### ParentRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The work order or work order line item for which the product is required. This field is a polymorphic relationship field. - **Relationship Name**: ParentRecord - **Relationship Type**: Lookup - **Refers To**: Visit, WorkOrder, WorkOrderLineItem ### ParentRecordType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies whether the parent record is a work order or a work order line item. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The required product. This is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the product required. ### ProductRequiredNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number identifying the product required. ### QuantityRequired - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Quantity required of the product. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Units of the required product. For example, kilograms or liters. Quantity Unit of Measure values are inherited from the Quantity Unit of Measure field on products. - **Possible values**: - Each # ProductRequirementSpecification Class Represents the resulting product requirement specification data. ## Namespace [ind\_mfg\_sample\_mgmt\_apex](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_namespace_ind_mfg_sample_mgmt_apex.htm "The ind_mfg_sample_mgmt_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards.") - **[ProductRequirementSpecification Properties](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_properties)** Learn more about the properties available with the ProductRequirementSpecification class. ## ProductRequirementSpecification Properties Learn more about the properties available with the ProductRequirementSpecification class. - **[accountId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_accountId)** The ID of the associated customer account. - **[contactId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_contactId)** The ID of the contact at the associated account. - **[createdById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_createdById)** The ID of the user who created the specification. - **[createdDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_createdDate)** The creation date and time of the specification. - **[customAttributes](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_customAttributes)** A JSON string containing custom fields and their values. - **[id](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_id)** The ID of the Product Requirement Specification. - **[lastModifiedById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_lastModifiedById)** The ID of the user who last modified the specification. - **[lastModifiedDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_lastModifiedDate)** The last modified date and time of the specification. - **[latestVersionId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_latestVersionId)** The ID of the latest version of the specification. - **[name](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_name)** The name of the Product Requirement Specification. - **[origin](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_origin)** The source that initiated the requirement. - **[ownerId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_ownerId)** The ID of the user who owns the specification. - **[priority](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_priority)** The priority of the requirement. - **[productRequirementSpecificationVersion](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_productRequirementSpecificationVersion)** A list of versions for this specification. - **[stage](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_stage)** The current stage of the specification in its workflow. - **[status](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecification_status)** The current status of the specification. ### accountId The ID of the associated customer account. #### Signature public String accountId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### contactId The ID of the contact at the associated account. #### Signature public String contactId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdById The ID of the user who created the specification. #### Signature public String createdById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdDate The creation date and time of the specification. #### Signature public String createdDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### customAttributes A JSON string containing custom fields and their values. #### Signature public String customAttributes {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### id The ID of the Product Requirement Specification. #### Signature public String id {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedById The ID of the user who last modified the specification. #### Signature public String lastModifiedById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedDate The last modified date and time of the specification. #### Signature public String lastModifiedDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### latestVersionId The ID of the latest version of the specification. #### Signature public String latestVersionId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### name The name of the Product Requirement Specification. #### Signature public String name {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### origin The source that initiated the requirement. #### Signature public String origin {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### ownerId The ID of the user who owns the specification. #### Signature public String ownerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### priority The priority of the requirement. #### Signature public String priority {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### productRequirementSpecificationVersion A list of versions for this specification. #### Signature public ind\_mfg\_sample\_mgmt\_apex.ProductRequirementSpecificationVersion productRequirementSpecificationVersion {get; set;} #### Property Value Type: [ind\_mfg\_sample\_mgmt\_apex.ProductRequirementSpecificationVersion](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion "A list of versions for this specification.") ### stage The current stage of the specification in its workflow. #### Signature public String stage {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### status The current status of the specification. #### Signature public String status {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") # ProductRequirementSpecificationItem Class A list of items for this specification version. ## Namespace [ind\_mfg\_sample\_mgmt\_apex](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_namespace_ind_mfg_sample_mgmt_apex.htm "The ind_mfg_sample_mgmt_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards.") - **[ProductRequirementSpecificationItem Properties](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_properties)** Learn more about the properties available with the ProductRequirementSpecificationItem class. ## ProductRequirementSpecificationItem Properties Learn more about the properties available with the ProductRequirementSpecificationItem class. The following are properties for ProductRequirementSpecificationItem. - **[acceptanceCriteria](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_acceptanceCriteria)** The measurable conditions for requirement fulfillment. - **[additionalInfo](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_additionalInfo)** Additional notes or instructions for this item. - **[category](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_category)** The type of requirement, such as Functional or Performance. - **[createdById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_createdById)** The ID of the user who created the item. - **[createdDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_createdDate)** The creation date and time of the item. - **[customAttributes](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_customAttributes)** A JSON string containing custom fields and their values. - **[id](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_id)** The ID of the specification item. - **[lastModifiedById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_lastModifiedById)** The ID of the user who last modified the item. - **[lastModifiedDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_lastModifiedDate)** The last modified date and time of the item. - **[name](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_name)** The name of the specification item. - **[ownerId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_ownerId)** The ID of the user who owns the item. - **[productRqmtSpecVersionId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_productRqmtSpecVersionId)** The ID of the parent specification version. - **[riskLevel](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_riskLevel)** The criticality of this requirement. - **[statement](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_statement)** A detailed, testable statement of the requirement. - **[targetValue](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_targetValue)** The specific, desired value for this requirement. - **[tolerance](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_tolerance)** The acceptable range of deviation from the target value. - **[unitOfMeasureId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_unitOfMeasureId)** The ID of the unit of measure for the target value and tolerance. - **[verificationMethod](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem_verificationMethod)** The method used to validate this requirement. ### acceptanceCriteria The measurable conditions for requirement fulfillment. #### Signature public String acceptanceCriteria {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### additionalInfo Additional notes or instructions for this item. #### Signature public String additionalInfo {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### category The type of requirement, such as Functional or Performance. #### Signature public String category {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdById The ID of the user who created the item. #### Signature public String createdById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdDate The creation date and time of the item. #### Signature public String createdDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### customAttributes A JSON string containing custom fields and their values. #### Signature public String customAttributes {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### id The ID of the specification item. #### Signature public String id {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedById The ID of the user who last modified the item. #### Signature public String lastModifiedById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedDate The last modified date and time of the item. #### Signature public String lastModifiedDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### name The name of the specification item. #### Signature public String name {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### ownerId The ID of the user who owns the item. #### Signature public String ownerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### productRqmtSpecVersionId The ID of the parent specification version. #### Signature public String productRqmtSpecVersionId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### riskLevel The criticality of this requirement. #### Signature public String riskLevel {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### statement A detailed, testable statement of the requirement. #### Signature public String statement {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### targetValue The specific, desired value for this requirement. #### Signature public String targetValue {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### tolerance The acceptable range of deviation from the target value. #### Signature public String tolerance {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### unitOfMeasureId The ID of the unit of measure for the target value and tolerance. #### Signature public String unitOfMeasureId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### verificationMethod The method used to validate this requirement. #### Signature public String verificationMethod {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") # ProductRequirementSpecificationVersion Class A list of versions for this specification. ## Namespace [ind\_mfg\_sample\_mgmt\_apex](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_namespace_ind_mfg_sample_mgmt_apex.htm "The ind_mfg_sample_mgmt_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards.") - **[ProductRequirementSpecificationVersion Properties](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_properties)** Learn more about the properties available with the ProductRequirementSpecificationVersion class. ## ProductRequirementSpecificationVersion Properties Learn more about the properties available with the ProductRequirementSpecificationVersion class. - **[additionalInfo](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_additionalInfo)** Additional notes or instructions for this version. - **[assumptions](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_assumptions)** Conditions or beliefs assumed to be true for the design. - **[constraints](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_constraints)** Limitations, such as cost or time, that must be met. - **[contentDocumentId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_contentDocumentId)** The ID of an attached document. - **[createdById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_createdById)** The ID of the user who created the version. - **[createdDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_createdDate)** The creation date and time of the version. - **[customAttributes](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_customAttributes)** A JSON string containing custom fields and their values. - **[effectiveDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_effectiveDate)** The date this specification version becomes valid. - **[expiryDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_expiryDate)** The date this specification version becomes obsolete. - **[id](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_id)** The ID of the specification version. - **[intendedUse](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_intendedUse)** The business or functional goal of the product. - **[lastModifiedById](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_lastModifiedById)** The ID of the user who last modified the version. - **[lastModifiedDate](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_lastModifiedDate)** The last modified date and time of the version. - **[name](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_name)** The name of the specification version. - **[ownerId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_ownerId)** The ID of the user who owns the version. - **[productRequirementSpecificationItems](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_productRequirementSpecificationItems)** A list of items for this specification version. - **[productRqmtSpecId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_productRqmtSpecId)** The ID of the parent specification. - **[purpose](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_purpose)** The business reason for the requirement. - **[refProductCategoryId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_refProductCategoryId)** The ID of the category for the reference product. - **[refProductId](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_refProductId)** The ID of a reference or baseline product. - **[scope](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_scope)** The defined boundaries for the product or project. - **[verificationMethod](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_verificationMethod)** The method used to confirm the requirement is met. - **[version](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion.htm#apex_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationVersion_version)** The version number. ### additionalInfo Additional notes or instructions for this version. #### Signature public String additionalInfo {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### assumptions Conditions or beliefs assumed to be true for the design. #### Signature public String assumptions {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### constraints Limitations, such as cost or time, that must be met. #### Signature public String constraints {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### contentDocumentId The ID of an attached document. #### Signature public String contentDocumentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdById The ID of the user who created the version. #### Signature public String createdById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### createdDate The creation date and time of the version. #### Signature public String createdDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### customAttributes A JSON string containing custom fields and their values. #### Signature public String customAttributes {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### effectiveDate The date this specification version becomes valid. #### Signature public String effectiveDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### expiryDate The date this specification version becomes obsolete. #### Signature public String expiryDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### id The ID of the specification version. #### Signature public String id {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### intendedUse The business or functional goal of the product. #### Signature public String intendedUse {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedById The ID of the user who last modified the version. #### Signature public String lastModifiedById {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### lastModifiedDate The last modified date and time of the version. #### Signature public String lastModifiedDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### name The name of the specification version. #### Signature public String name {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### ownerId The ID of the user who owns the version. #### Signature public String ownerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### productRequirementSpecificationItems A list of items for this specification version. #### Signature public List productRequirementSpecificationItems {get; set;} #### Property Value Type: List [ind\_mfg\_sample\_mgmt\_apex.ProductRequirementSpecificationItem](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem.htm#apex_class_ind_mfg_sample_mgmt_apex_ProductRequirementSpecificationItem "A list of items for this specification version.") ### productRqmtSpecId The ID of the parent specification. #### Signature public String productRqmtSpecId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### purpose The business reason for the requirement. #### Signature public String purpose {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### refProductCategoryId The ID of the category for the reference product. #### Signature public String refProductCategoryId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### refProductId The ID of a reference or baseline product. #### Signature public String refProductId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### scope The defined boundaries for the product or project. #### Signature public String scope {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### verificationMethod The method used to confirm the requirement is met. #### Signature public String verificationMethod {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_string.htm#apex_methods_system_string "HTML (New Window)") ### version The version number. #### Signature public Integer version {get; set;} #### Property Value Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_methods_system_integer.htm#apex_methods_system_integer "HTML (New Window)") # ProductRqmtSpec Defines a complete set of requirements. It captures key information such as the associated Account and Contact, tracks its overall lifecycle status, and acts as the parent for all related requirement items and their versions. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: A unique identifier for the requirement specification. ### Account - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The customer account associated with this requirement. ### Contact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary contact person at the associated customer account. ### Status - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The lifecycle state of the requirement. ### Origin - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The source or stakeholder that initiated the requirement. ### Priority - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The priority of the requirement for successful delivery. ### Stage - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The current stage of the requirement specification workflow based on user-defined statuses. ### LatestVersion - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The current active version of the requirement specification. # ProductRqmtSpecItem Represents a specific and measurable requirement within a requirement specification for a requested product. Defines what must be delivered and how to verify its fulfilment. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ProductRqmtSpecVersion - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The parent requirement specification that this item belongs to. ### Category - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of requirement, such as functional, performance, or safety. ### Statement - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The clear, detailed, and testable statement describing the requirement. ### AcceptanceCriteria - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The measurable conditions that must be met for the requirement to be considered fulfilled. ### TargetValue - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The specific, desired value or outcome expected for this requirement. ### Tolerance - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The acceptable deviation range from the target value.v ### UnitOfMeasure - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit in which the target value and tolerance are measured. ### VerificationMethod - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The specific method used to validate that the requirement is met. ### RiskLevel - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The level of risk associated with not meeting this requirement. ### AdditionalInfo - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The extra notes, context, or guidance relevant to this requirement item. # ProductRqmtSpecVersion Represents a specific, numbered snapshot of a Requirement Specification at a particular time, outlining the purpose, scope, constraints, and validation methods. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ProductRqmtSpec - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The parent requirement specification that this version belongs to. ### Version - **Type**: Int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The version number of a specific requirement specification. ### Purpose - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The key business reason behind the requirement request. ### IntendedUse - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The business or functional goals the product is expected to fulfill. ### Scope - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The defined boundaries, objectives, and context of the requirement or project. ### Assumptions - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The conditions assumed to be true during the design or planning phase. ### Constraints - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: The limitations such as time, cost, regulatory, or technical constraints that apply. ### VerificationMethod - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The method used to validate that the requirement has been met ### RefProduct - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The standard product used as a reference or benchmark. ### RefProductCategory - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product category of the referenced product. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this requirement specification is considered valid. ### ExpiryDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The date after which this requirement specification is considered obsolete or expired. ### ContentDocument - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The documents attached to support or provide context for the requirement. ### AdditionalInfo - **Type**: text - **Properties**: Filter, Group, Nillable, Sort - **Description**: Any extra details, notes, or instructions for this specific version. # ProductServiceCampaign Represents a set of activities to be performed for a product service campaign. For example, a recall of products due to potential safety hazards or an upgrade of products to comply with legal regulations. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableListId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actionable list of the assets that are a part of a product service campaign. This field is a relationship field. - **Relationship Name**: ActionableList - **Relationship Type**: Lookup - **Refers To**: ActionableList ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product service campaign. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the product service campaign ends. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the product service campaign. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the product service campaign. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductServiceCampaignName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the product service campaign. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the product service campaign starts. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The status of the product service campaign. - **Default value**: New - **Possible values**: - In Progress - New ### StatusCategory - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The category of a status value. StatusCategory field has eight default values: seven values that are identical to the default Status values, and None for statuses without a status category. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Waiting for Response value, add it the On Hold category. - **Default value**: None - **Possible values**: - Canceled - CannotComplete—Cannot Complete - Closed - Completed - InProgress—In Progress - New - None - OnHold—On Hold ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of the product service campaign. - **Possible values**: - Modification - New - Recall - Service - Upgrade ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type associated with the product service campaign. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType # ProductServiceCampaignItem Represents an item, such as an asset or a serialized product, that’s included in a product service campaign. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableListMemberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actionable list member that’s associated with an asset in a product service campaign. This field is a relationship field. - **Relationship Name**: ActionableListMember - **Relationship Type**: Lookup - **Refers To**: ActionableListMember ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset associated with the product service campaign item. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### GeneratedTargetRecordType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the type of the target records that are generated for the product service campaign item. - **Default value**: None - **Possible values**: - None - WorkOrder—Work Order ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the product service campaign item. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductServiceCampaignId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign that includes the product service campaign item. This field is a relationship field. - **Relationship Name**: ProductServiceCampaign - **Relationship Type**: Master-detail - **Refers To**: ProductServiceCampaign (the master object) ### ProductServiceCampaignItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The unique identifier of the product service campaign item. ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The serialized product associated with the product service campaign item. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Relationship Type**: Lookup - **Refers To**: SerializedProduct ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The status of the product service campaign item. ### StatusCategory - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The category for a status value. - **Default value**: None - **Possible values**: - Canceled - CannotComplete—Cannot Complete - Closed - Completed - InProgress—In Progress - New - None - OnHold—On Hold # ProductSvcCampaignDef Represents information about the product or part that is impacted in a product service campaign. Stores the granular details related to product faults, facilitating efficient execution of the product service campaign. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BusinessBrandId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the business brand on the product record related to the product service campaign definition. This field is a relationship field. - **Relationship Name**: BusinessBrand - **Refers To**: BusinessBrand ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the product service campaign definition. ### EndingSerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The serial number of the last impacted item in a serialized batch of items associated with a product service campaign. ### ImpactedUnitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual number of units impacted of the product service campaign definition. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MakeName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the make name on the product record related to the product service campaign definition. ### ManufacturerLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location of the manufacturer associated with the product service campaign definition. This field is a relationship field. - **Relationship Name**: ManufacturerLocation - **Refers To**: Location ### ModelName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model name on the product record related to the product service campaign definition. ### ModelYear - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Auto-populated based on the model year on the product record related to the product service campaign definition. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product service campaign definition. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The impacted product of a product service campaign. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductSvcCampaignGrpDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product service campaign group definition associated with the product service campaign definition. This field is a relationship field. - **Relationship Name**: ProductSvcCampaignGrpDef - **Relationship Type**: Master-detail - **Refers To**: ProductSvcCampaignGrpDef (the master object) ### ProductionEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when a manufacturer ended production for a faulty product associated with a product service campaign. ### ProductionStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when a manufacturer began production for a faulty product associated with a product service campaign. ### StartingSerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The serial number of the first impacted item in a serialized batch of items associated with a product service campaign. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductSvcCampaignDefChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProductSvcCampaignDefHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProductSvcCampaignGrpDef Represents information about product service campaign definitions within groups based on attributes, such as the origin, status, or consequences of a campaign. Helps compliance officers define the scope and type of a product service campaign group before execution. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualCompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the tasks associated with the product service event are completed. ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional information about the product service campaign group definition. ### ClaimCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The approximate number of claims raised for the product service event. ### Classification - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of the product service, such as a recall mandated by the government or a recall initiated due to customer complaints. ### CurrentImpact - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The current impact of the product service event. ### CustomerContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The point of contact for all communication with the customer. This field is a relationship field. - **Relationship Name**: CustomerContact - **Refers To**: User ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the product service campaign group definition. ### ExpectedCompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the tasks associated with the product service event are planned for completion. ### ExternalDataSource - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external data source where the product service group campaign definition is recorded. ### ExternalId - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the product service campaign group definition in an external system. ### IncidentCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of incidents that have occurred for which a product service campaign needs to take place to prevent such incidences in the future, such as injuries. ### InitiationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the product service event is initiated. ### InternalContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The point of contact for all communication with the manufacturer associated with a product service campaign. This field is a relationship field. - **Relationship Name**: InternalContact - **Refers To**: User ### IsMajorRecall - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the recall event is major (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the product service campaign group definition. ### PotentialRisks - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The potential risks on stakeholders, such as an automotive company or customers, that could arise due to the non-implementation of a product service campaign. ### ReportedBy - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The agency that reported the product service event. ### ReportingDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the product service event is reported by a relevant stakeholder. ### ResolutionMeasures - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The measure taken to contain the product service event. ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The severity of the product service event, such as critical, high, medium, or low. - **Possible values**: - Critical - High - Low - Medium ### SourceDocumentReference - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The document of reference from an external source. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a product service campaign, such as new, open, withdrawn, or closed. ### TotalImpactedUnitCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The total number of product units to be impacted by a product service campaign. This field is a calculated field. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of a product service campaign, such as a campaign for recall, upgrade or maintenance. - **Possible values**: - Maintenance - Recall - Upgrade ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[ProductSvcCampaignGrpDefChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events."):** Change events are available for the object. **[ProductSvcCampaignGrpDefHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # ProductTransfer Represents the transfer or the movement of a product item between two inventory locations. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the product transfer. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place the product is to be delivered. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ExpectedPickupDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the product is expected to be picked up. ### InventoryOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents operations performed on the inventory, such as transfers, disbursements, or adjustments. This field is a relationship field. - **Relationship Name**: InventoryOperation - **Refers To**: InventoryOperation ### IsReceived - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies if the product was received (true) or not (false). ### IsProduct2Serialized - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies whether the product associated with the product transfer is a serialized product (true) or not (false). - **Default value**: false ### IsReceived - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the product was received (true) or not (false). - **Default value**: false ### IsSent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the product was sent as a part of the transfer (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the product transfer. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product that’s associated with the product transfer. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### Product2TransferRecordMode - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: If serialized, specifies when the serial number is recorded. It is visible on the product transfer as a read-only field depending on the field-level security. - **Possible values**: - SendAndReceive —The serial number is recorded when sending or receiving. - ReceiveOnly —The serial number is recorded when receiving only. - **Relationship Name**: Product2.TransferRecordMode - **Relationship Type**: Lookup - **Refers To**: Product2.TransferRecordMode ### ProductRequestId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product request that’s associated with the product transfer This field is a relationship field. - **Relationship Name**: ProductRequest - **Relationship Type**: Lookup - **Refers To**: ProductRequest ### ProductRequestLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product request line item associated with the product transfer. This field is a relationship field. - **Relationship Name**: ProductRequestLineItem - **Relationship Type**: Lookup - **Refers To**: ProductRequestLineItem ### ProductTransferNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number that identifies the product transfer. ### QuantityReceived - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of product received at the destination location. ### QuantitySent - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of product sent from the source location. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The units of the product, for example grams, liters, or units. - **Possible values**: - Each ### ReceivedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person that receives the product at the destination location. This field is a polymorphic relationship field. - **Relationship Name**: ReceivedBy - **Relationship Type**: Lookup - **Refers To**: Group, User ### ReturnOrderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The return order associated with the product transfer. This field is a relationship field. - **Relationship Name**: ReturnOrder - **Relationship Type**: Lookup - **Refers To**: ReturnOrder ### ReturnOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The return order line item associated with the product transfer. This field is a relationship field. - **Relationship Name**: ReturnOrderLineItem - **Relationship Type**: Lookup - **Refers To**: ReturnOrderLineItem ### ShipmentExpectedDeliveryDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the shipment is expected at the product transfer shipment. ### ShipmentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The shipment associated with the product transfer. This field is a relationship field. - **Relationship Name**: Shipment - **Relationship Type**: Lookup - **Refers To**: Shipment ### ShipmentStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The status of the shipment associated with the product transfer. ### ShipmentTrackingNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of the shipment associated with the product transfer. ### ShipmentTrackingUrl - **Type**: url - **Properties**: Filter, Group, Nillable, Sort - **Description**: The tracking URL of the shipment associated with the product transfer. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source location associated with the product transfer. This field is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### SourceProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product item associated with the product transfer. This field is a relationship field. - **Relationship Name**: SourceProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the product transfer. # ProductTransferState Represents an action taken to associate a serialized product with a product transfer. The new state is a result of the action. A product transfer state record is created when serialized products are attached to the product transfer. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Action - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The action that must be performed on the inventory item. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated name of the product transfer state. ### ProductTransferId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The transfer for which this inventory transaction was requested. This field is a relationship field. - **Relationship Name**: ProductTransfer - **Relationship Type**: Lookup - **Refers To**: ProductTransfer ### SerializedProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serialized product being transferred. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Relationship Type**: Lookup - **Refers To**: SerializedProduct ### TransferState - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The new status for the inventory item. # ProductWarrantyTerm Defines the relationship between a product or product family and a warranty term. This object is available in Manufacturing Cloud in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CoveredProductFamily - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product family that the warranty term applies to. - **Possible values**: - None ### CoveredProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product that the warranty term applies to. This field is a relationship field. - **Relationship Name**: CoveredProduct - **Relationship Type**: Lookup - **Refers To**: Product2 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product warranty term was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product warranty term was last viewed. ### ProductWarrantyTermNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The identifier for this product warranty term. ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the associated warranty term. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm # PurchaseOrder Represents the Purchase Order entity that captures a formal request from a Buyer to a Supplier to supply goods or services. It is identified by a unique PurchaseOrderNumber and tracks the order's lifecycle via a StatusCode. It defines commercial terms like the TotalAmount, BillingAccount, and the governing PriceBook. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### PurchaseOrderNumber - **Type**: autonumber - **Properties**: Filter, Group, idLookup, Sort - **Description**: A unique identifier for the purchase order. ### PurchaseOrderDate - **Type**: datetime - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date and time when the purchase order was created. ### PurchaseOrderType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of the purchase order such as standard, blanket, and contract. - **Possible values**: - Standard Purchase Order - Blanket Purchase Order ### BuyerAccount - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The buyer account that initiated the purchase order. This field is a relationship field. - **Relationship Name**: BuyerAccount - **Refers To**: Account ### SupplierAccount - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The supplier account that received the purchase order. This field is a relationship field. - **Relationship Name**: SupplierAccount - **Refers To**: Account ### BuyerContact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary contact person associated with the buyer account. This field is a relationship field. - **Relationship Name**: BuyerContact - **Refers To**: Contact ### SupplierContact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary contact person associated with the supplier account. This field is a relationship field. - **Relationship Name**: SupplierContact - **Refers To**: Contact ### StatusCode - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The current status of the product in the purchase order. - **Possible values**: - Approved - AwaitingApproval - Cancelled - Closed - Delivered - Draft - Invoiced - PartiallyReceived - Received - Shipped - Submitted ### BillingAccount - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account to which invoices are issued for the purchase order. This field is a relationship field. - **Relationship Name**: BillingAccount - **Refers To**: Account ### BillToContact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The contact associated with the billing account. This field is a relationship field. - **Relationship Name**: BillToContact - **Refers To**: Contact ### PriceBook - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The price book that specifies the item prices applicable to the purchase order. This field is a relationship field. ### AdditionalInfo - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional notes or remarks related to the purchase order. ### TotalAmount - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sum of all total amounts from the PO Lines. ### ExternalPurchaseOrderNumber - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference number associated with the purchase order. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specify the context in which the Purchase Order is created. - **Possible values**: - DistributorManagement - PurchaseOrderManagement ### RequestedDeliveryDate - **Type**: datetime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The requested delivery date for the product. ### ShippingLocation - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location to which the product is to be shipped. This field is a relationship field. ### ShippingAddress - **Type**: address - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The address to which the product is to be shipped. ### ShipToContact - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact associated with the shipping location. This field is a relationship field. ### ShipToAccount - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the shipping location. This field is a relationship field. # PurchaseOrderItem Represents an individual line on a parent Purchase Order, detailing a specific product or service being procured. It captures the core transactional data including the Quantity, UnitPrice, a reference to the Product, and the calculated LineTotal. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### PurchaseOrderItemNumber - **Type**: autonumber - **Properties**: Filter, Group, idLookup, Sort - **Description**: A unique identifier for the product in the purchase order. ### PurchaseOrder - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The parent purchase order associated with the product. ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The Id of the product associated with the purchase order. ### PricebookEntry - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The pricebook entry that defines the price for the specified product. ### ListPrice - **Type**: currency - **Properties**: Filter, Group, Nillable, Sort - **Description**: The list price of the product. ### DiscountPercentage - **Type**: percent - **Properties**: Filter, Group, Nillable, Sort - **Description**: The percentage of discount applied to the unit price of the product. ### NetUnitPrice - **Type**: currency - **Properties**: Filter, Group, Nillable, Sort - **Description**: The price of the product per unit after applying discounts. ### OrderedQuantity - **Type**: double - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of units ordered for the product. ### QuantityUnitOfMeasure - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unit of measure for the ordered quantity. ### TotalAmount - **Type**: currency - **Properties**: Filter, Group, Nillable, Sort - **Description**: The total cost for the specified product. ### StatusCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current status of the product in the purchase order. - **Possible values**: - Approved - Cancelled - Closed - Delivered - Draft - PartiallyReceived—Partially Received - Received - Shipped - Submitted ### RequestedDeliveryDate - **Type**: datetime - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The requested delivery date for the product. ### ShippingLocation - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location to which the product is to be shipped. ### ShipToContact - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact associated with the shipping location. ### ShippingAddress - **Type**: address - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The address to which the product is to be shipped. ### QuantityReceived - **Type**: double - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of the product received to date. ### AdditionalInfo - **Type**: text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional notes or remarks related to the product. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[PurchaseOrderItemHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object."):** History is available for tracked fields of the object. # PurchaseOrderMgmtSettings Represents the settings for enabling Manufacturing features like Purchase Order Management. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location PurchaseOrderMgmtSettings components have the suffix PurchaseOrderMgmt.settings and are stored in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component. ## Version PurchaseOrderMgmtSettings components are available in API version 66.0 and later. ## Fields ### enablePurchaseOrderMgt - **Field Type**: boolean - **Description**: Indicates whether the Purchase Order Management feature of Manufacturing Cloud is enabled (true) or turn off (false) for your org. The default value is false. ## Declarative Metadata Sample Definition The following is an example of a PurchaseOrderMgmtSettings component. true The following is an example package.xml that references the previous definition. PurchaseOrderMgmt Settings 66.0 ## Wildcard Support in the Manifest File The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about by using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # Recalculate Forecasts Action Recalculate forecasts based on orders, opportunity, and sales agreement figures. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note These actions update the forecast data in your Salesforce org. You must perform a database rollback to undo these actions. For more information about recalculating actual values of an active sales agreement, see [Use Manufacturing Actions in Flow Builder and Process Builder](https://help.salesforce.com/s/articleView?id=ind.admin_manufacturing_standard_invocable_actions.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This object is available in API version 47.0 and later for users with Manufacturing Cloud license. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/recalculateForecast **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs | Input | Type | Description | | --- | --- | --- | | userId | ID | The ID of the user. An email is sent to this user when the action is complete. | | forecastId | string | The ID of the forecast for recalculation. Use ALL to recalculate all account forecasts. | ## Usage **Sample Request to recalculate one account forecast** The following example shows how to recalculate one account forecast: { "inputs": \[{ "userId":"005xx000001X7QLAA0", "forecastId":"0yAxx0000000001EAA" }\] } **Sample Request to recalculate all account forecasts** The following example shows how to recalculate all account forecasts: { "inputs": \[{ "userId":"005xx000001X7QLAA0", "forecastId":"ALL" }\] } # RecordActionDeployment Represents configuration settings for the Actions & Recommendations and Action Launcher components. RecordActionDeployment is available in API version 45.0 and later. ## Supported SOAP Calls create(), delete(), describeLayout(), describeSObject(), query(), retrieve(), update()upsert() ## Supported REST HTTP Methods GET, HEAD, PATCH, POST, DELETE ## Fields ### ChannelConfigurations - **Type**: [RecordActionDeploymentChannel](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordactiondeployment.htm#recordactiondeployment/recordActionDeploymentChannel "HTML (New Window)") - **Properties**: Not applicable. - **Description**: Channel default settings for the deployment. This field is visible only in the metadata for a record. ### ComponentName - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the name of the component used in the deployment. Available in API version 56.0 and later. - **Possible values**: - ActionLauncher—1 - ActionsAndRecommendations—0 ### DeploymentContexts - **Type**: [RecordActionDeploymentContext](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordactiondeployment.htm#recordactiondeployment/recordActionDeploymentContext "HTML (New Window)") - **Properties**: Not applicable. - **Description**: Object context for the deployment. This field is visible only in the metadata for a record. Available in API version 46.0 and later. ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: A unique name for this record action deployment. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Provides a globally unique identifier for the record action deployment, which prevents conflicts with other record action deployments that have the same MasterLabel. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. ### FullName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unique name used as the record action deployment identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### HasGuidedActions - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: If true, indicates that the component shows standard actions; for example, flows and quick actions. Available in API version 46.0 and later. ### HasOmniscripts - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record actions deployment includes OmniScripts (true) or not (false). Available in API version 56.0 and later. - **Default value**: false ### HasRecommendations - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: If true, indicates that the component shows recommendations from a Next Best Action strategy. Available in API version 46.0 and later. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the record action deployment. The following values are supported: - Chinese (Simplified): zh\_CN - Chinese (Traditional): zh\_TW - Danish: da - Dutch: nl\_NL - English: en\_US - Finnish: fi - French: fr - German: de - Italian: it - Japanese: ja - Korean: ko - Norwegian: no - Portuguese (Brazil): pt\_BR - Russian: ru - Spanish: es - Spanish (Mexico): es\_MX Spanish (Mexico) defaults to Spanish for customer-defined translations. - Swedish: sv - Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English. ### ManageableState - **Type**: ManageableState enumerated list - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The name of the deployment. ### Metadata - **Type**: [RecordActionDeployment](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordactiondeployment.htm "HTML (New Window)") - **Properties**: Create, Nillable, Update - **Description**: Metadata that defines record action deployments. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with the record action deployment, which is assigned to the AppExchange package. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. The namespace helps differentiate custom objects and fields from those in use by other record action deployments. ### Recommendation - **Type**: [RecordActionRecommendation](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordactiondeployment.htm#recordactiondeployment/recordActionRecommendation "HTML (New Window)") - **Properties**: Not applicable. - **Description**: Settings for how Next Best Action recommendations appear. This field is visible only in the metadata for a record. Available in API version 46.0 and later. ### SelectableItems - **Type**: [RecordActionSelectableItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_recordactiondeployment.htm#recordactiondeployment/recordActionDeploymentSelectableItemsID "HTML (New Window)") - **Properties**: Not applicable. - **Description**: A subset of actions that users can launch at runtime. This field is visible only in the metadata for a record. # Refresh Actuals Calculation Action Refresh actuals calculations for sales agreements for current and past periods. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note These actions update the actuals data in your Salesforce org. You must perform a database rollback to undo these actions. For information on how the refreshActualsCalculation action can be used in a flow, see [Use Manufacturing Actions in Flow Builder and Process Builder](https://help.salesforce.com/s/articleView?id=ind.admin_manufacturing_standard_invocable_actions.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This object is available in API version 47.0 and later for users with the Manufacturing Sales Agreements permission set. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/refreshActualsCalculation **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs
Input Type Description
userId ID The ID of the user. An email is sent to this user when the action is complete.
salesAgreementId string The ID of the sales agreement for refreshing actuals.
isCurrentAndFutureSchedules boolean Indicates whether to refresh actuals for the current schedule period only (false) or for the current schedule period and future schedules (true). When true, the number of future schedules is based on the FutureActCalcSchedules field on the sales agreement.

If you specify true for both isCurrentAndFutureSchedules and isCurrentSchedule, the action fails with an error.

isCurrentSchedule boolean Indicates whether to refresh actuals for the current period (true) or current and past periods (false).
## Usage **Sample Request** Here's a sample request for the Refresh Actuals Calculation action. { "inputs" : \[{ "userId" : "005Ws000001Agn0IAC", "salesAgreementId": "0YAWs0000004FkBOAU", "isCurrentSchedule": true, "isCurrentAndFutureSchedules": false }\] } **Sample Response** Here's a sample success response for the Refresh Actuals Calculation action. \[ { "actionName": "refreshActualsCalculation", "errors": null, "isSuccess": true, "outputValues": { "isSuccess": true, "message": "Actuals calculation refreshed successfully", "recordsProcessed": 15, "salesAgreementId": "0YAWs0000004FkBOAU" } } \] **Error Response** Here's a sample error response for the Refresh Actuals Calculation action. \[ { "actionName": "refreshActualsCalculation", "errors": \[ { "statusCode": "INVALID\_INPUT", "message": "Sales Agreement not found or user does not have access", "fields": \["salesAgreementId"\] } \], "isSuccess": false, "outputValues": null } \] # Request Bodies Here’s a list of Manufacturing Cloud Business API request bodies. - **[Inventory Allocation Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_input.htm)** Input representation for inventory allocation. - **[Inventory Allocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_data.htm)** List of records associated to a source ID. - **[Inventory Allocation Item](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_item.htm)** Individual inventory item ID with locations for allocation process. - **[Inventory Allocation Location](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_allocation_location.htm)** Individual location ID with allocated quantity. - **[Inventory Deallocation Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_input.htm)** Input representation to cancel product item allocations. - **[Inventory Deallocation Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_data.htm)** Source group containing inventory items for deallocation process. - **[Inventory Deallocation Item](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_item.htm)** Individual inventory item for deallocation process. - **[Inventory Deallocation Location](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_inventory_deallocation_location.htm)** Individual location with serialized or batched product IDs for deallocation. - **[Process Addl Txn Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_process_addl_txn_input.htm)** Input for processing additional product item transactions. - **[Product Requirement Specification Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_input.htm)** Input representation for the Product Requirement Specification data to process. - **[Product Requirement Specification Item Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_item_input.htm)** Input representation of a list of items associated with this version. - **[Product Requirement Specification Version Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_version_input.htm)** Input representation for a list of specification versions, including version data and associated items. - **[Sales Agreement Default Fields Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_default_fields_input.htm)** Input representation of default values for the sales agreement fields. - **[Sales Agreement Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_input.htm)** Input representation to convert a source object to a sales agreement. - **[Sales Agreement Product Attribute Details Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_attribute_details_input.htm)** Input representation of an attribute associated with a sales agreement product. - **[Sales Agreement Product Details Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_details_input.htm)** Input representation of a product and its pricing, quantity, and attribute details for a sales agreement. - **[Sales Agreement Product Management Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_management_input.htm)** Input representation of products and their attributes to create or update in a sales agreement. - **[Sample Management Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sample_management_input.htm)** Input for creating, updating, or versioning a Product Requirement Specification. - **[Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_transformation_input.htm)** Input representation for converting an input object type to an output object type. - **[Warranty To Supplier Claims Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_warranty_to_supplier_claims_input.htm)** Input representation to create supplier recovery claims from warranty claims. # Resources Here’s a list of Manufacturing Cloud Business API resources. - **[Inventory Allocation (GET)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_get_inventory_allocation.htm)** Fetches the allocation status, quantities, and source locations for all line items associated with a given entity. - **[Inventory Allocation (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_inventory_allocation.htm)** Allocates the given source locations along with allocated quantities to selected item IDs. - **[Inventory Deallocation (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_inventory_deallocation.htm)** Deallocates the given source locations for selected item IDs. - **[Process Additional Transaction (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_process_additional_transaction.htm)** Processes additional transactions for product items in manual synchronization scenarios. - **[Sales Agreement (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_sales_agreement.htm)** Create a sales agreement from an external source, including quote, opportunity, or custom object. - **[Sales Agreement Product (PUT)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_sales_agreement_product.htm)** Add or update products and their pricing and attribute details in a sales agreement. - **[Sample Management (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_sample-management.htm)** Creates, updates, or versions Product Requirement Specification records. - **[Transformations (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_transformations.htm)** Perform the business transformation of program component forecast data (source object) to opportunities (target object). The following are some of the transformation scenarios: MfgProgramCpntFrcstFact to Opportunity, ManufacturingProgram to Opportunity, MfgProgramCpntFrcstFact to OpportunityLineItem, and Period to OpportunityLineItemSchedule. - **[Warranty To Supplier Claims (POST)](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_resources_warranty_to_supplier_claims.htm)** Warranty to Supplier Claims API clones the existing warranty claim and its hierarchy such as claim items, claim coverage, and claim coverage payment details. # Response Bodies Here’s a list of Manufacturing Cloud Business API response bodies. - **[Get Inventory Allocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_output.htm)** Returns the allocation status, quantities, and source locations for all line items associated with a given entity. - **[Get Inventory Allocation Line Item Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_line_item_data.htm)** Allocation data associated to a line item. - **[Get Inventory Allocation Location Data](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_location_data.htm)** Allocation data associated to each location for the line item id. - **[Get Inventory Allocation Instance Reservation](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_get_inventory_allocation_instance_reservation.htm)** Instance-level reservation for a serialized product not in a batch. - **[Inventory Allocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_inventory_allocation_output.htm)** Output representation for inventory allocation. - **[Inventory Deallocation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_inventory_deallocation_output.htm)** Output representation to cancel product item allocations. - **[Pagination Meta](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_pagination_meta.htm)** Pagination metadata for the API responses. - **[Process Addl Txn Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_process_addl_txn_output.htm)** Result of the additional product item transaction process. - **[Object Details Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_output_object_detail.htm)** Represents the details of the transformation object. - **[Product Requirement Specification Error](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_error.htm)** Error representation for Product Requirement Specification operations. - **[Product Requirement Specification Error Detail](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_error_detail.htm)** Error representation for Product Requirement Specification operations. Null if the operation was successful. - **[Product Requirement Specification Item Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_item_output.htm)** Output representation of the list of items for this specification version. - **[Product Requirement Specification Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_output.htm)** Output representation of the resulting Product Requirement Specification data. - **[Product Requirement Specification Version Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_version_output.htm)** Output representation of the list of versions for this specification. - **[Sales Agreement Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement.htm)** Output representation of the sales agreement conversion result. - **[Sales Agreement Product Management Response](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement_product_management.htm)** Output representation of the result of a sales agreement product request. - **[Sales Agreement Product Management Error Details](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement_product_management_error.htm)** Output representation of an error returned for a sales agreement product request. - **[Sample Management Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sample_management_output.htm)** Output representation of the response for a Product Requirement Specification operation. - **[Transformation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_transformation.htm)** Represents the details of the transformation from source object to target object. - **[Warranty To Supplier Claims Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_warranty_to_supplier_claims.htm)** Output representation with the supplier recovery claims created from warranty claims. # REST Reference You can access Manufacturing Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. To understand the architecture, authentication, rate limits, and how the requests and responses work, see [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm). - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_cloud_apis_resources.htm)** Here’s a list of Manufacturing Cloud Business API resources. - **[Request Bodies](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_cloud_apis_requests.htm)** Here’s a list of Manufacturing Cloud Business API request bodies. - **[Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/manufacturing_cloud_apis_responses.htm)** Here’s a list of Manufacturing Cloud Business API response bodies. # ReturnOrder Represents the repair, return, or recall of product items. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the return order. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the return order. This is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact associated with the return order. This is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the return order. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the items are being returned to. For example, if the return order tracks the return of products from a technician’s van to a warehouse, the warehouse is the destination location. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ExpectedArrivalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the items are expected to arrive at the destination location. ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date after which authorizations can’t be captured. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### OrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order associated with the return order. When you associated a return order with an order, you can associate the return order’s line items with order products. This is a relationship field. - **Relationship Name**: Order - **Relationship Type**: Lookup - **Refers To**: Order ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the return order. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product request associated with the return order. When you associated a return order with a product request, you can associate the return order’s line items with the product request’s line items. A return order might be related to a product request if the return order tracks the return of unused products or products to be repaired or replaced. For example, a technician creates a product request for three motors to prepare for a field visit. If the technician finds that only two motors are needed, they can create a return order to return the third to the original location, and list the product request in this field. This is a relationship field. - **Relationship Name**: ProductRequest - **Relationship Type**: Lookup - **Refers To**: ProductRequest ### ReturnOrderNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number identifying the return order. ### ReturnedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user returning the items. This is a relationship field. - **Relationship Name**: ReturnedBy - **Relationship Type**: Lookup - **Refers To**: User ### ShipFromAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipFromCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipFromCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipFromGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the return shipping address. ### ShipFromLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### ShipFromLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### ShipFromPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipFromState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipFromStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address. ### ShipmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of shipment associated with the return order. Available values are: - Standard (default value) - Rush - Overnight - Next Business Day - Pick Up ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service center to a warehouse, the service center is the source location. This is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the return order. Available values are: - Draft - Submitted - Approved - Canceled - Closed ### StatusCategory - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Status category of the return order. Processing of the return order depends on this value. Each status category corresponds to one or more statuses. - **Possible values**: - Activated - Canceled - Closed - Draft # ReturnOrderLineItem Represents a product that is returned, recalled, or repaired as part of a return order. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset associated with the return order line item. This is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the return order line item. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the items are being returned to. For example, if the return order tracks the return of products from a technician center to a warehouse, the warehouse is the destination location. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### OrderItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order product associated with the return order line item. This is a relationship field. - **Relationship Name**: OrderItem - **Relationship Type**: Lookup - **Refers To**: OrderItem ### ProcessingPlan - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the preferred fate of the items after their return. Available values are: - Repair—Repair the items and return them to the owner - Discard—Discard the items - Salvage—Salvage the items’ working parts - Restock—Return the items to your inventory ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the return order line item. This is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product item representing the location of the product at the start of the return. This is a relationship field. - **Relationship Name**: ProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### ProductRequestLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product request line item associated with the return order line item. This is a relationship field. - **Relationship Name**: ProductRequestLineItem - **Relationship Type**: Lookup - **Refers To**: ProductRequestLineItem ### QuantityExpected - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of items expected to be returned. ### QuantityReceived - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual quantity of items received for return. ### QuantityRejected - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of items rejected for return. ### QuantityReturned - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of items being returned. If multiple types of products are being returned, track each product in a different return order line item. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Units of the returned items. For example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. ### ReasonForRejection - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for rejecting returned items on this return order line item. - **Default value**: Missing Item or Part - **Possible values**: - Damaged Item - Expired Warranty - Missing Item or Part - Wrong Item ### ReasonForReturn - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The reason the items are being returned. Available values are: - Damaged - Defective - Duplicate Order - Wrong Item - Wrong Quantity - Not Satisfied - Outdated - Other ### ReasonForChangeText - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The details about the reason for the return change ### RepaymentMethod - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The method by which the customer or owner will be reimbursed for the items being returned. Available values are: - Replace—The items will be replaced - Refund—The items will be returned and the owner will be refunded - Credit—The items will be returned and the owner will receive credit for them - Return—The items will be returned to the owner (for example, following their repair) ### ReturnOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The return order that the return order line item belongs to. This is a relationship field. - **Relationship Name**: ReturnOrder - **Relationship Type**: Lookup - **Refers To**: ReturnOrder ### ReturnOrderLineItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated number that identifies the return order line item. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service center to a warehouse, the service vehicle is the source location. This is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location # Sales Agreement (POST) Create a sales agreement from an external source, including quote, opportunity, or custom object. ## Resource /services/data/vXX.X/connect/manufacturing/sales-agreements ## Available Version 51.0 ## Requires Chatter No ## HTTP Methods POST ## Special Access Rules To use this resource, your Salesforce org must have the Manufacturing Cloud license with the Sales Agreements permission set. ## Prerequisite Before you use the resource, use the new ConvertToSalesAgreement mapping usage type available in ObjectHierarchyRelationship settings to map an input object (quote or opportunity) to an output object (sales agreement) and define field mappings. All the products from the source object child entity will be added to the sales agreement. For example, see the [ObjectHierarchyRelationship](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/mfg_objecthierarchyrelationshipsettings_metadata_api.htm) metadata type for the mapping definition from Opportunity to SalesAgreement (parent level mapping) and OpportunityLineItem to SalesAgreementProduct (child level mapping). To use decimal values, map the quantity values to InitialPlannedQtyValue. #### See Also - [SalesAgreement](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreement.htm "SalesAgreement - HTML (New Window)") - [SalesAgreementProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_objects_salesagreementproduct.htm "SalesAgreementProduct - HTML (New Window)") ## Request Body for POST ### JSON Example { "sourceObjectId": "0kFT1000000000RMAQ", "salesAgreementDefaultValues": { "salesAgreement": { "StartDate": "2020-01-01", "ScheduleFrequency": "Monthly", "ScheduleCount": "10" }, "salesAgreementProduct": { "PricebookEntry": "01uxx00000091jOAAQ", "Name": "test-sap1", "InitialPlannedQuantity":"1" } } } ### Properties
Name Type Description Required or Optional Available Version
salesAgreement​​​DefaultValues Sales Agreement Default​​ Fields Input[] Default field values for the SalesAgreement and SalesAgreementProduct entities that aren’t defined in the mapping definition.

Note: You can remove a mapping field from the definition by providing the output field value as blank for SalesAgreement or SalesAgreementProduct.

 Optional 51.0
sourceObjectId String ID of the source object containing the mapping definition used to create the sales agreement record. Required 51.0
## Response Body for POST [Sales Agreement Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement.htm "Output representation of the sales agreement conversion result.") # Sales Agreement Default Fields Input Input representation of default values for the sales agreement fields. ## JSON example with decimal quantity { "salesAgreementDefaultValues": { "salesAgreement": { "StartDate": "2020-01-01", "ScheduleFrequency": "Monthly", "ScheduleCount": "10" }, "salesAgreementProduct": { "PricebookEntry": "01uxx00000091jOAAQ", "Name": "test-sap1", "InitialPlannedQtyValue": "1.5", "IsQuantityInDecimals": "true" } } } ## JSON example without decimal quantity { "salesAgreementDefaultValues": { "salesAgreement": { "StartDate": "2020-01-01", "ScheduleFrequency": "Monthly", "ScheduleCount": "10" }, "salesAgreementProduct": { "PricebookEntry": "01uxx00000091jOAAQ", "Name": "test-sap1", "InitialPlannedQuantity": "1" } } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | salesAgreement | Map | Default field values of the sales agreement entity that aren’t defined in the mapping definition. | Optional | 51.0 | | salesAgreement​​Product​ | Map | Default field values of the sales agreement product entity that aren’t defined in the mapping definition. | Optional | 51.0 | If isQuantityInDecimals is not specified or set to false, existing integer-based mappings will continue to work as before. # Sales Agreement Input Input representation to convert a source object to a sales agreement. ## JSON Example { "sourceObjectId": "0kFT1000000000RMAQ", "salesAgreementDefaultValues": { "salesAgreement": { "StartDate": "2020-01-01", "ScheduleFrequency": "Monthly", "ScheduleCount": "10" }, "salesAgreementProduct": { "PricebookEntry": "01uxx00000091jOAAQ", "Name": "test-sap1", "InitialPlannedQuantity":"1" } } } ## Properties
Name Type Description Required or Optional Available Version
salesAgreement​​​DefaultValues Sales Agreement Default​​ Fields Input[] Default field values for the SalesAgreement and SalesAgreementProduct entities that aren’t defined in the mapping definition.

Note: You can remove a mapping field from the definition by providing the output field value as blank for SalesAgreement or SalesAgreementProduct.

 Optional 51.0
sourceObjectId String ID of the source object containing the mapping definition used to create the sales agreement record. Required 51.0
# Sales Agreement Output Output representation of the sales agreement conversion result. ## JSON Example { "salesAgreementId": "0YAxx00000004Ob" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | salesAgreement​Id | String | ID of the sales agreement record that gets created after the request is successful. | Small, 51.0 | 51.0 | # Sales Agreement Product (PUT) Add or update products and their pricing and attribute details in a sales agreement. ## Resource /connect/sales-agreements/salesAgreementId/product ## Resource Example https://yourInstance.salesforce.com/services/data/v68.0/connect/sales-agreements/0YAAAC00000B393/product ## Available Version 60.0 ## HTTP Methods PUT ## Special Access Rules The org must have Revenue Management for Sales Agreements enabled. The running user must have Manufacturing Cloud access to the product catalog feature and permission to update sales agreements, with the appropriate object and field permissions for Sales Agreement, Sales Agreement Product, Product, Price Book, and Price Book Entry. ## Prerequisites Configure pricing for sales agreements, including the default pricing context definition. Use an active price book entry for the product in the specified price book. If pricing isn’t configured, the response can return isSuccess as false with a pricing error. ## Request Parameters | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | salesAgreementId | String | ID of the sales agreement in which to add or update products. | Required | 60.0 | ## Request Body for PUT ### JSON Example Here’s an example of a request to add a product to a sales agreement: { "pricebook2Id": "01sAAC00002tGfhYBE", "salesAgreementProductDetails": \[ { "product2Id": "01tAAC0000ADt2cYBD", "pricebookEntryId": "01uAAC00000nRggYBE", "initialPlannedQuantity": 10, "salesPrice": 4500 } \] } Here’s an example of a request that includes a product attribute: { "pricebook2Id": "01sAAC00002tGfhYBE", "salesAgreementProductDetails": \[ { "product2Id": "01tAAC0000ADt2cYBD", "pricebookEntryId": "01uAAC00000nRggYBE", "initialPlannedQuantity": 10, "salesPrice": 4500, "discountPercentage": 5, "salesAgreementProductAttributeDetails": \[ { "attributeDefinitionName": "Color", "attributeValue": "Red", "isPriceImpacting": false } \] } \] } ### Properties ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note All request properties are optional in the API schema. To add products, provide at least one salesAgreementProductDetails entry with product2Id, pricebookEntryId, initialPlannedQuantity, and salesPrice. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | pricebook2Id | String | The ID of the price book associated with the sales agreement. | Optional | 60.0 | | salesAgreementProductDetails | [Sales Agreement Product Details Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_details_input.htm "Input representation of a product and its pricing, quantity, and attribute details for a sales agreement.")\[\] | The details of the sales agreement product. | Optional | 60.0 | ## Response Body for PUT [Sales Agreement Product Management Response](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement_product_management.htm "Output representation of the result of a sales agreement product request.") # Sales Agreement Product Attribute Details Input Input representation of an attribute associated with a sales agreement product. ## JSON Example { "attributeDefinitionName": "Color", "attributeValue": "Red", "isPriceImpacting": false } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeDefinitionId | String | The ID of the attribute definition associated with the sales agreement product attribute. | Optional | 60.0 | | attributeDefinitionName | String | The name of the attribute definition. | Optional | 60.0 | | attributePicklistValueId | String | The ID of the attribute picklist value associated with the sales agreement product attribute. | Optional | 60.0 | | attributeValue | String | The value of the sales agreement product attribute. | Optional | 60.0 | | isPriceImpacting | Boolean | Indicates whether the attribute impacts the price of the product (true) or not (false). The default value is false. | Optional | 61.0 | # Sales Agreement Product Details Input Input representation of a product and its pricing, quantity, and attribute details for a sales agreement. ## JSON Example { "product2Id": "01tAAC0000ADt2cYBD", "pricebookEntryId": "01uAAC00000nRggYBE", "initialPlannedQuantity": 10, "salesPrice": 4500, "discountPercentage": 5, "salesAgreementProductAttributeDetails": \[ { "attributeDefinitionName": "Color", "attributeValue": "Red", "isPriceImpacting": false } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | discountPercentage | Double | Percent of discount offered on the sales price. | Optional | 60.0 | | guidancePrice | Double | The guidance price that's calculated using the pricing rules. | Optional | 60.0 | | initialPlannedQuantity | Double | The total quantity of the product that you initially plan to sell across the sales agreement term. | Optional | 60.0 | | lastPricingExecIdentifier | String | The unique identifier for the last price waterfall information. | Optional | 60.0 | | pricebookEntryId | String | The ID of the price book entry associated with the sales agreement product. | Optional | 60.0 | | product2Id | String | The ID of the product in the sales agreement product. | Optional | 60.0 | | salesAgreementProductAttributeDetails | [Sales Agreement Product Attribute Details Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_attribute_details_input.htm "Input representation of an attribute associated with a sales agreement product.")\[\] | The details of the sales agreement product attribute. | Optional | 60.0 | | salesAgreementProductId | String | The ID of the sales agreement product. Specify this ID when updating an existing product in the sales agreement. | Optional | 60.0 | | salesPrice | Double | Price per unit at which you initially decide to sell the product. | Optional | 60.0 | # Sales Agreement Product Management Error Details Output representation of an error returned for a sales agreement product request. ## JSON Example { "code": "INTERNAL\_ERROR", "message": "We couldn't fetch the pricing information. Ask your Salesforce admin for help." } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | The code of the error due to which the request failed. | Small, 60.0 | 60.0 | | message | String | The message explaining why the request failed. | Small, 60.0 | 60.0 | # Sales Agreement Product Management Input Input representation of products and their attributes to create or update in a sales agreement. ## JSON Example Here’s an example of a request to add a product to a sales agreement: { "pricebook2Id": "01sAAC00002tGfhYBE", "salesAgreementProductDetails": \[ { "product2Id": "01tAAC0000ADt2cYBD", "pricebookEntryId": "01uAAC00000nRggYBE", "initialPlannedQuantity": 10, "salesPrice": 4500 } \] } Here’s an example of a request that includes a product attribute: { "pricebook2Id": "01sAAC00002tGfhYBE", "salesAgreementProductDetails": \[ { "product2Id": "01tAAC0000ADt2cYBD", "pricebookEntryId": "01uAAC00000nRggYBE", "initialPlannedQuantity": 10, "salesPrice": 4500, "discountPercentage": 5, "salesAgreementProductAttributeDetails": \[ { "attributeDefinitionName": "Color", "attributeValue": "Red", "isPriceImpacting": false } \] } \] } ## Properties ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note All request properties are optional in the API schema. To add products, provide at least one salesAgreementProductDetails entry with product2Id, pricebookEntryId, initialPlannedQuantity, and salesPrice. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | pricebook2Id | String | The ID of the price book associated with the sales agreement. | Optional | 60.0 | | salesAgreementProductDetails | [Sales Agreement Product Details Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_sales_agreement_product_details_input.htm "Input representation of a product and its pricing, quantity, and attribute details for a sales agreement.")\[\] | The details of the sales agreement product. | Optional | 60.0 | # Sales Agreement Product Management Response Output representation of the result of a sales agreement product request. ## JSON Example Here’s an example of an unsuccessful request when pricing isn’t configured: { "errorDetails": \[ { "code": "INTERNAL\_ERROR", "message": "We couldn't fetch the pricing information. Ask your Salesforce admin for help." } \], "isSuccess": false, "salesAgreementId": "0YAAAC00000B393" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorDetails | [Sales Agreement Product Management Error Details](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_sales_agreement_product_management_error.htm "Output representation of an error returned for a sales agreement product request.")\[\] | The details of the error if the operation was unsuccessful. | Small, 60.0 | 60.0 | | isSuccess | Boolean | Indicates whether the operation was successful (true) or not (false). | Small, 60.0 | 60.0 | | salesAgreementId | String | The ID of the sales agreement record. | Small, 60.0 | 60.0 | # SalesAgreement Represents a long-term agreement between a buyer and a seller to negotiate price and volume of products.This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the referenced account. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ActivatedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time on which the sales agreement is activated. ### ActualMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The total actual margin amount as a percentage of total actual amount. ### ActualsCalculationMode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The mode used by the application to calculate actual quantities for a sales agreement. - **Possible values**: - DataProcessingEngine—Using a Data Processing Engine Definition - Manual—Manually using API upload - Orders—Automatically from direct orders - OrdersThroughContracts—Automatically from orders through contracts ### AgreementType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: This field is deprecated. We recommend not adding it to the page layout. Type of the sales agreement. Currently, a sales agreement is always volume-based. ### ApprovedById - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the user who approves the sales agreement. This field is a relationship field. - **Relationship Name**: ApprovedBy - **Relationship Type**: Lookup - **Refers To**: User ### ApprovedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time on which the sales agreement was approved. ### CancellationDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time on which the sales agreement was canceled. ### CancellationReason - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: Reason for canceling the sales agreement. Values can be customized. Examples include low profit, unavailability of products, and so on. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of a contact associated with the sales agreement account. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### DecimalScale - **Type**: int - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The number of decimal places applied to values in a sales agreement. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: User-defined context and information about the sales agreement. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date and time on which the sales agreement expires. ### FutureActCalcSchedules - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of future schedules to include in actuals calculations in the sales agreement. ### LastActualsCalculatedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time on which actuals were last calculated either by the automated daily job or by the ad-hoc action performed by an individual user. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: User-defined name of the sales agreement. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user who owns this record. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PlannedMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The total planned margin amount as a percentage of total planned amount. ### PriceAdjustmentScheduleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The price adjustment schedule that's associated with the sales agreement. Available in API version 59.0 and later. This field is a relationship field. - **Relationship Name**: PriceAdjustmentSchedule - **Refers To**: PriceAdjustmentSchedule ### PricebookId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the associated price book. - **Relationship Name**: Pricebook - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### ProductLevel - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Level of the products associated with the sales agreement. - **Default value**: Product - **Possible values**: - Product - ProductCategory—Category ### ReferenceFieldId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manufacturing program associated with the sales agreement. Available in API version 57.0 and later. This field is a relationship field. - **Relationship Name**: ReferenceField - **Refers To**: ManufacturingProgram ### RenewedFromAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the immediate parent from which the sales agreement is renewed. This field is a relationship field. - **Relationship Name**: RenewedFromAgreement - **Relationship Type**: Lookup - **Refers To**: SalesAgreement ### RenewedToAgreementId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the renewed sales agreement. This field is a relationship field. - **Relationship Name**: RenewedToAgreement - **Relationship Type**: Lookup - **Refers To**: SalesAgreement ### ScheduleCount - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Number of schedules in the sales agreement. ### ScheduleFrequency - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Frequency at which schedules occur in the sales agreement. - **Default value**: Weekly - **Possible values**: - Monthly - Onetime—One-Time - Quarterly - Weekly - Yearly ### ShouldUserSpecPlnQuantity - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user specifies the planned quantity of products in a sales agreement (true) or the initial planned quantity of each product is automatically distributed across all schedules (false). - **Default value**: false ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Date on which the sales agreement must get activated. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Status of the sales agreement. The values can be customized but must map to at least one of the predefined status codes. - **Default value**: Draft - **Possible values**: - Activated - Approved - Cancelled - Draft - Expired - Rejected - UnderRevision ### StatusCode - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Set of five predefined status codes that determine at which stage is the sales agreement in. - **Default value**: Draft - **Possible values**: - Activated - Approved - Cancelled - Draft - Expired - Rejected - UnderRevision ### TotalActualAgreementAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the total actual amounts across all products in a sales agreement. This field is a calculated field. ### TotalActualCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the total actual cost amounts across all products in a sales agreement. This field is a calculated field. ### TotalActualMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the total actual margin amounts across all products in a sales agreement. This field is a calculated field. ### TotalAgreementAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Total value of the sales agreement. This field is a calculated field. ### TotalPlannedCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the total planned cost amounts across all products in a sales agreement. This field is a calculated field. ### TotalPlannedMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the total planned margin amounts across all products in a sales agreement. This field is a calculated field. ### TotalProposedAgreementAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Total value of the sales agreement when the sales agreement is under revision. This field is a calculated field. ### ArePredfndStatusValOveride - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the predefined status code validations apply to the sales agreement (true) or not (false). If customers use their custom statuses and validations, internally the agreement is set to the Draft status code to allow the custom validations. ### ClonedFromAgreement - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sales agreement from which the current record was deep cloned. This field is a relationship field. - **Refers To**: SalesAgreement ## Associated Object This object has the following associated object. Unless noted, it is available in the same API version as this object. **[SalesAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. # SalesAgreementProdSchdAdj Represents the manual adjustments made to metric values for a sales agreement product schedule. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdjustedBy - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who’s made an adjustment to the sales agreement product schedule record. ### SalesAgreementProdSchedule - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The sales agreement product schedule record to which an adjustment was made. ### AdvAcctForecastMeasureDefId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The measure definition of the advanced account forecast record to which the adjustment is being made. ### InitialValue - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The value in the sales agreement product schedule record before the adjustment is made. ### UpdatedValue - **Type**: number - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the adjustment made to a sales agreement product schedule. ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information provided by the user who made the adjustments. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the adjustment made to a sales agreement product schedule. - **Possible values**: - Applied - InReview - Rejected # SalesAgreementProduct Represents the total quantity or amount and the default pricing information of a product or category across the total time period of the sales agreement.This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The total actual margin amount as a percentage of total actual amount. ### AreSchedulesCreatedManually - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether schedules are created automatically or manually. ### CostPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cost of manufacturing one unit of a product. This field is a calculated field. ### DiscountPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Percent of discount offered on the sales price. ### DisplayName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The display name of a sales agreement product that's displayed in the sales agreements table, and sales agreement product related lists and record pages. If a display name isn't specified, the name of the sales agreement product is displayed. Use this field to distinguish between sales agreement products with the same products but with different attributes. ### GuidancePrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The guidance price that's calculated using the core pricing rules. This price is used to determine the sales price. ### InitialPlannedAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of the product or category that you initially plan on selling across the sales agreement term. ### InitialPlannedQtyValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The initial quantity of a product planned for sale across schedules in a sales agreement. This field stores initial product quantity in decimals. ### InitialPlannedQuantity - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The total quantity of the product or category that you initially plan on selling across the sales agreement term. ### IsActualsCalculationProduct - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this product is used for actuals calculations instead of other products with the same product name. - **Default value**: false ### IsAddedAfterActivation - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the sales agreement product or category is added after the sales agreement was activated. - **Default value**: false ### IsQuantityInDecimals - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the quantities of the sales agreement product are decimal values (true) or integer values (false). - **Default value**: false ### IsUnderRevision - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the sales agreement product or category is under revision or not. In an under revision state, edits can be made and if approved, the edits are automatically incorporated and the sales agreement is reactivated. ### LastPricingExecIdentifier - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The unique identifier for the last price waterfall information. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### ListPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price of a product as specified in a price book. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the product or category. ### PlannedMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The total planned margin amount as a percentage of total planned amount. ### PricebookEntryId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the referenced price book. ### ProductCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The product category associated with the sales agreement. This is a relationship field. - **Relationship Name**: ProductCategory - **Relationship Type**: Lookup - **Refers To**: ProductCategory ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the product. ### SalesAgreementId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the sales agreement to which the product is added. ### SalesPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price per unit of the unit at which you initially decide to sell the product. ### TotalActualAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Field displaying the sum of actual amounts across all schedules at a given time. ### TotalActualCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the actual cost amounts across all schedules in a sales agreement. This field is a calculated field. ### TotalActualMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the actual margin amounts across all schedules in a sales agreement. This field is a calculated field. ### TotalActualQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Field displaying the sum of actual quantities across all schedules at a given time. ### TotalActualQuantityValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of actual quantities of a product across all schedules in a sales agreement. This field stores the sum of actual quantities in decimals. This field is a calculated field. ### TotalActualShipmentQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the actual shipment quantities of a product across all schedules in a sales agreement. This field is a calculated field. ### TotalClonedActualQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The rolled up cumulative actual quantity based on the cloned actual quantities for each sales agreement product schedule. This field is a calculated field. ### TotalForecastedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Field displaying the sum of forecasted amounts across all schedules at a given time. ### TotalForecastedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Field displaying the sum of forecasted quantities across all schedules at a given time. ### TotalForecastedQtyValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of forecasted quantities of a product across all schedules in a sales agreement. This field stores the sum of forecasted quantities in decimals. This field is a calculated field. ### TotalPlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Field displaying the sum of planned amounts across all schedules at a given time. ### TotalPlannedCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the planned cost amounts across all schedules in a sales agreement. This field is a calculated field. ### TotalPlannedMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the planned margin amounts across all schedules in a sales agreement. This field is a calculated field. ### TotalPlannedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Field displaying the sum of planned quantities across all schedules at a given time. ### TotalPlannedQuantityValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of planned quantities of a product across all schedules in a sales agreement. This field stores the sum of planned quantities in decimals. This field is a calculated field. ### TotalPlannedShipmentQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the planned shipment quantities of a product across all schedules in a sales agreement. This field is a calculated field. ### TotalProposedPlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Field displaying the sum of planned amounts across all schedules at a given time when the sales agreement is under revision. ### TotalProposedPlannedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Field displaying the sum of planned quantities across all schedules at a given time when the sales agreement is under revision. ### TotalProposedPlnQtyValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of proposed quantities of a product across all schedules in a sales agreement. This field stores the sum of proposed quantities in decimals. This field is a calculated field. ### TotalUnallocatedOrderQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the unallocated order quantities of a product across all schedules in a sales agreement. This field is a calculated field. ### TotalUnallocatedOrderRevenue - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the unallocated order revenue of a product across all schedules in a sales agreement. This field is a calculated field. ### TotalUnallocatedPlannedQty - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the initial planned quantity value and total planned quantity value of a product that's distributed manually. ## Associated Objects This object has the following associated objects. Unless noted, it is available in the same API version as this object. **[SalesAgreementProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0):** Change events are available for the object. **[SalesAgreementProductHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")** History is available for tracked fields of the object. This object is available in API version 49.0 and later. # SalesAgreementProductSchedule Represents the quantity or amount and the pricing information of a product or category for a particular schedule of the sales agreement. This object is available in API version 47.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields ### ActualAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Actual amount per product per schedule of a sales agreement. ### ActualCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cost of manufacturing the actual quantity of a product. ### ActualMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the sales price and cost price for the actual quantity of a product. ### ActualMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the sales price and cost price for the actual quantity of a product, expressed as a percentage of the sales price. ### ActualQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Actual quantity per product per schedule of a sales agreement. ### ActualQuantityValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The actual quantity of a product for a specific schedule in a sales agreement. This field stores the actual quantity in decimals. ### ActualShipmentQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The actual quantity of a product being shipped to a partner. ### ClonedActualQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The actual quantity copied over from an agreement from which the current sales agreement product schedule was deep cloned. ### CostPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The cost of manufacturing one unit of a product. ### DerivedPlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Planned amount per product per schedule of a sales agreement. ### DiscountPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Percent of discount per unit of the product for a specific schedule. ### EndDate - **Type**: date - **Properties**: Filter, Group, Sort - **Description**: Date on which the schedule ends. ### ForecastedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Forecasted amount per product per schedule of a sales agreement. ### ForecastedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Forecasted Quantity per product per schedule of a sales agreement. ### ForecastedQuantityValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The forecasted quantity of a product for a specific schedule in a sales agreement. This field stores the forecasted quantity in decimals. ### IsUnderRevision - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicator of whether the sales agreement product schedule is under revision or not. In an under revision state, edits can be made and if approved, the edits are automatically incorporated and the sales agreement is reactivated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which this record was viewed. ### MaximumOrderQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The maximum quantity for a product in a single order. ### MinimumPurchaseQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The minimum quantity of a product that a partner must purchase for a specific schedule. ### MinimumPurchaseRevenue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The minimum revenue of a product that must be generated for a specific schedule. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: User-defined name of the schedule. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Make sure you enter a name that correctly captures the month, quarter, or year for the particular schedule. So, if a schedule is from 15 Aug to 15 Sept, the name by Name it 15 Aug-15Sep so that actuals are reflected correctly for that schedule. - **Default value**: August ### PlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: Planned amount for a product for a specific schedule. ### PlannedCostAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cost of manufacturing the planned quantity of a product. ### PlannedMarginAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the sales price and cost price for the planned quantity of a product. ### PlannedMarginPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the sales price and cost price for the planned quantity of a product, expressed as a percentage of the sales price. ### PlannedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Planned quantity for a product for a specific schedule. ### PlannedQuantityValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The planned quantity of a product for a specific schedule in a sales agreement. This field stores the planned quantity in decimals. ### PlannedShipmentQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The planned quantity of a product to be shipped to a partner. ### ProposedCostPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The proposed cost for one unit of a product when the sales agreement is under revision. ### ProposedDerivedPlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Planned amount for a product for a specific schedule when the sales agreement is under revision. ### ProposedDiscountPercentage - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Discount per unit per schedule of the product at which you want to sell it when the sales agreement is under revision. ### ProposedPlannedAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: Planned amount for a product for a specific schedule when the sales agreement is under revision. ### ProposedPlannedQuantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Planned quantity for a product for a specific schedule when the sales agreement is under revision. ### ProposedPlannedQtyValue - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The planned quantity of a product for a specific schedule in a sales agreement that's under revision. This field stores the planned quantity in decimals. ### ProposedSalesPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price per unit per schedule of the product at which you want to sell it when the sales agreement is under revision. ### SalesAgreementProductId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the sales agreement product of which the schedule is a part. ### SalesPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price per unit per schedule of the product at which you want to sell it. ### StartDate - **Type**: date - **Properties**: Filter, Group, Sort - **Description**: Date on which the schedule starts. ### UnallocatedOrderQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort, Update - **Description**: The ordered quantity of a product that isn't associated with a sales agreement. ### UnallocatedOrderRevenue - **Type**: currency - **Properties**: Filter, Nillable, Sort, Update - **Description**: The revenue generated from an order that isn't associated with a sales agreement. ## Associated Object This object has the following associated object. Unless noted, it is available in the same API version as this object. **[SalesAgreementProductScheduleHistory](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")** History is available for tracked fields of the object. This object is available in API version 49.0 and later. # SalesAgreementSettings Represents settings that control the display of agreement terms metrics in sales agreements and the calculation of the actual quantity of products in sales agreements. These settings also control the approval of sales agreements. Available in API version 57.0 and later. ## Supported SOAP Calls create(), describeSObjects(), query(), retrieve(),update(), upsert() ## Supported REST HTTP Methods GET, POST, PATCH, PUT ## Fields ### ActualsCalculationMode - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Source from which the actual ordered quantity of a product in a sales agreement is calculated. - **Default value**: Manual - **Possible values**: - DataProcessingEngine—Using a Data Processing Engine Definition—Available in API version 63.0 and later. - Manual—Manually using API upload - Orders—Automatically from direct orders - OrdersThroughContracts—Automatically from orders through contracts. ### AdvAcctFrcstDisplayGroupForecastSet - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The forecast set associated with the sales agreement group. This is a relationship field. ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The developer name for SalesAgreementSettings. ### DisplayedAgreementTermsMetrics - **Type**: textarea - **Properties**: Filter, Sort - **Description**: Metrics that are selected for display in Agreement Terms in a specified sequence. There can be a maximum of 10 comma-separated metric names in this list. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### IsOnlyApprovalProcessUsed - **Type**: boolean - **Properties**: Default on Create, Filter, Group, Sort - **Description**: Indicates whether both self-approval and approval of sales agreements are allowed (true) or only approval of sales agreements is allowed false) through the Approval Flow. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the sales agreement settings. ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Master label for SalesAgreementSettings. This internal label doesn’t get translated. ### PrimaryNotifEmailAddress - **Type**: email - **Properties**: Filter, Group, Nillable, Sort - **Description**: The email address to which notifications are sent. ### RenewalPeriodDayCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of days before the end date of a sales agreement from when the agreement can be renewed. Available in API version 50.0 and later. ### SecondaryNotifEmailAddress - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The second email address to which notifications are sent. # SalesAgreeProductAttribute Represents a virtual object that stores the key-value pairs for attributes of sales agreement products. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), update(), upsert() ## Fields ### AttributeDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The definition of the attribute that describes the sales agreement product. This field is a relationship field. - **Relationship Name**: AttributeDefinition - **Relationship Type**: Lookup - **Refers To**: AttributeDefinition ### AttributeDefinitionName - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: The name of the sales agreement product attribute. ### AttributePicklistValueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value in the attribute picklist that describes the sales agreement product. This field is a relationship field. - **Relationship Name**: AttributePicklistValue - **Relationship Type**: Lookup - **Refers To**: AttributePicklistValue ### AttributeValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value of the sales agreement product attribute. ### SalesAgreementProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The sales agreement product that the sales agreement product attribute describes. This field is a relationship field. - **Relationship Name**: SalesAgreementProduct - **Relationship Type**: Lookup - **Refers To**: SalesAgreementProduct ### UnitOfMeasure - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unit of measure associated with the sales agreement product attribute. This field is a relationship field. - **Relationship Name**: UnitOfMeasure - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure # SalesContractLine Stores a contract's product information, including price, quantity, and components covered. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Identifier of the parent contract. This field is a relationship field. - **Relationship Name**: Contract - **Relationship Type**: Lookup - **Refers To**: Contract ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the sales contract line. ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from which the line item is effective. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date till which the line item is effective. ### ExpenseRecoveryType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of expense recovery from the supplier. - **Possible values**: - PartExpense—Part Expense - TotalExpense—Total Expense ### IsPartReturnRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether it's mandatory for the manufacturer to return the product to the supplier for the supplier contract to apply. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LineItemNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique number of the line item. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the contract line item. ### OriginalLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the original line item that this line item references (for example if this line item is due to a contract amendment). This field is a relationship field. - **Relationship Name**: OriginalLineItem - **Refers To**: SalesContractLine ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product ID associated with the line item. This field is a relationship field. - **Relationship Name**: Product2 - **Refers To**: Product2 ### ProductCode - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Product code associated with the line item. ### Quantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Product quantity associated with the line item. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the contract line item. ### TotalPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total price of the line item based on the quantity and unit price. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of a single unit of the line item. # Sample Management Input Input for creating, updating, or versioning a Product Requirement Specification. ## JSON Example { "requestUniqueId": "insert\_op\_req\_1", "operation": "Insert", "productRequirementSpecification": { "properties": \[ { "field": "Name", "value": "Project Everest Core Requirements" }, { "field": "AccountId", "value": "001xx000003GaGxAAK" }, { "field": "Status", "value": "Draft" }, { "field": "Alias\_\_c", "value": "Requirements1136" } \], "productRequirementSpecificationVersions": \[ { "properties": \[ { "field": "Name", "value": "Functional1136" }, { "field": "Purpose", "value": "To define the minimum viable product (MVP) features for Project Everest." }, { "field": "Version", "value": "2" }, { "field": "Scope", "value": "To define the minimum viable product (MVP) features for Project Everest." } \], "productRequirementSpecificationItems": \[ { "properties": \[ { "field": "Name", "value": "Functional1136" }, { "field": "Statement", "value": "The system shall display a real-time summary of key performance indicators (KPIs) on the main dashboard." }, { "field": "AcceptanceCriteria", "value": "The system shall display a real-time summary of key performance indicators (KPIs) on the main dashboard." }, { "field": "Category", "value": "Functional" } \] } \] } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | operation | String | The action to perform. | Required | 66.0 | | productRequirementSpecification | [Product Requirement Specification Input](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_requests_product_requirement_specification_input.htm "Input representation for the Product Requirement Specification data to process.")\[\] | The Product Requirement Specification data to process. | Required | 66.0 | | requestUniqueId | String | A unique ID for request tracing. This ID is returned in the response. | Optional | 66.0 | # Sample Management Output Output representation of the response for a Product Requirement Specification operation. ## JSON Example { "requestUniqueId": "req-98765-xyz", "status": "SUCCESS", "message": "Product Requirement Specification retrieved successfully", "data": { "id": "0Dm5g000000KyZ3CAK", "name": "Pharmaceutical Grade Tablet Specification", "status": "Active", "priority": "High", "productRequirementSpecificationVersions": \[ { "id": "0Dn5g000000LmN4CAK", "name": "Version 2.0", "version": 2, "purpose": "Define specifications for manufacturing pharmaceutical tablets", "effectiveDate": "2024-02-01T00:00:00.000Z", "productRequirementSpecificationItems": \[ { "id": "0Do5g000000MpQ5CAK", "name": "Tablet Weight", "category": "Physical", "targetValue": "500", "tolerance": "5", "unitOfMeasureId": "UoM5g000000AbCdEFG" }, { "id": "0Do5g000000MpQ6CAK", "name": "Dissolution Rate", "category": "Chemical", "targetValue": "85", "tolerance": "5", "unitOfMeasureId": "UoM5g000000AbCdEFH" } \] } \] }, "errors": null } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | data | [Product Requirement Specification Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_output.htm "Output representation of the resulting Product Requirement Specification data.")\[\] | The resulting Product Requirement Specification data | Small, 66.0 | 66.0 | | errors | [Product Requirement Specification Error Detail](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_product_requirement_specification_error_detail.htm "Error representation for Product Requirement Specification operations. Null if the operation was successful.")\[\] | A list of errors. Null if the operation was successful | Small, 66.0 | 66.0 | | message | String | A message confirming the result of the operation | Small, 66.0 | 66.0 | | requestUniqueId | String | The unique ID from the request, used for tracing | Small, 66.0 | 66.0 | | status | String | The status of the operation | Small, 66.0 | 66.0 | # SampleRequest Represents a request for product samples, including customer account details, request date and status. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: text - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the sample request. ### Account - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### Contact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### SalesRepresentative - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### Contact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### Contact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### Contact - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### SampleRequest - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### SampleItemReference - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Indicates the specific sample product which can be either a standard product or a custom product requirement. ### Product - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the standard sample product requested in the sample request. ### ProductRequirementSpecification - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique product specification required for the sample, if not a standard product. ### ProductCategory - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The category of the sample product being requested. ### Purpose - **Type**: text - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reason for requesting this particular product or sample. ### Quantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity of the product or sample requested. ### UnitOfMeasure - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unit of measure for the requested sample. ### BatchNumber - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The specific product batch associated with the requested sample product. ### SalesPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sales price of the sample product. ### CostPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cost of the sample product. ### AdditionalInfo - **Type**: text - **Properties**: Filter, Nillable, Sort - **Description**: The additional details or special instructions for the sample product. ### PriceBookEntry - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The price book entry defining the sample product's price. ### CostBookEntry - **Type**: reference - **Properties**: Filter, Nillable, Sort - **Description**: The cost book entry defining the sample product's cost. ### ListPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price of a product as specified in a price book. # SampleRequestItem Represents information on items associated with a sample request, including details such as product, custom specifications, quantity and price. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: text - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the sample product. ### SampleRequest - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The sample request to which the product is associated. ### SampleItemReference - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Indicates the specific sample product which can be either a standard product or a custom product requirement. ### Product - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the standard sample product requested in the sample request. ### ProductRequirementSpecification - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique product specification required for the sample, if not a standard product. ### ProductCategory - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The category of the sample product being requested. ### Purpose - **Type**: text - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reason for requesting this particular product or sample. ### Quantity - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The quantity of the product or sample requested. ### UnitOfMeasure - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unit of measure for the requested sample. ### BatchNumber - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The specific product batch associated with the requested sample product. ### SalesPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sales price of the sample product. ### CostPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The cost of the sample product. ### AdditionalInfo - **Type**: text - **Properties**: Filter, Nillable, Sort - **Description**: The additional details or special instructions for the sample product. ### PriceBookEntry - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The price book entry defining the sample product's price. ### CostBookEntry - **Type**: reference - **Properties**: Filter, Nillable, Sort - **Description**: The cost book entry defining the sample product's cost. ### ListPrice - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Price of a product as specified in a price book. # SellerProduct Represents information about the products associated with a seller. Provides insight into product availability, production details, and the seller's role for the product, such as for sales or for service. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account associated with the product. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the seller stopped selling or servicing this product. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is still associated with the seller (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the account. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### SellerRole - **Type**: multipicklist - **Properties**: Create, Filter, Update - **Description**: The role of the seller related to the product, such as for sales or for service. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the seller started selling or servicing this product. ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. **[SellerProductHistory](https://developer.salesforce.com/docs/atlas.en-us.260.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm):** History is available for tracked fields of the object. # SerializedProduct Records serial numbers for each product in an inventory. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The asset that’s associated with the serialized product. This field is a relationship field. - **Relationship Name**: Asset - **Relationship Type**: Lookup - **Refers To**: Asset ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the product expires. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the serialized product record. This is auto-generated. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the serialized product. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product that is serialized. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product item associated with the serialized product. This field is a relationship field. - **Relationship Name**: ProductItem - **Relationship Type**: Lookup - **Refers To**: ProductItem ### SerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serial number of the product. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the product. - **Default value**: Available - **Possible values**: - Available - Consumed - Damaged - Lost - Sent # SerializedProductTransaction Represents a change in the state of a serialized product. This object is available in API version 60.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the serialized product transaction. ### RelatedRecordId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product consumed or the product transfer record associated with the serialized product transaction. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Relationship Type**: Lookup - **Refers To**: ProductConsumed, ProductTransfer ### SerializedProductId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The serialized product associated with the serialized product transaction. This field is a relationship field. - **Relationship Name**: SerializedProduct - **Relationship Type**: Lookup - **Refers To**: SerializedProduct ### TransactionType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of the transaction. - **Possible values**: - Adjusted - Consumed - Damaged - Found - Lost - Received - Repaired - Replenished - Sent - Withdrawn # Settings Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type. For more information, see **[Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm)**. The following list links to Settings metadata types used in Manufacturing Cloud. - [MfgServiceConsoleSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/mfg_mfgserviceconsolesettings_metadata_api.htm) Represents the settings to access the Service Console for Manufacturing. - [WarrantyLifeCycleMgmtSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_mfg_warrantylifecyclemgmtsettings.htm) Represents settings that control the Warranty Administration for your org. # Shipment Represents a product item that’s in transit between two inventory locations. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualDeliveryDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the product was delivered. ### DeliveredToId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or entity the product was delivered to. This is a polymorphic relationship field. - **Relationship Name**: DeliveredTo - **Relationship Type**: Lookup - **Refers To**: Group, User ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the shipment. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place the product is to be delivered. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### ExpectedDeliveryDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the product is expected to be delivered. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the shipment. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ReturnOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The return order associated with a return shipment. ### ShipFromAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The place the product is coming from. ### ShipFromCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the address where the shipment originates. ### ShipFromCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the address where the shipment originates. ### ShipFromGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the address where the shipment originates. ### ShipFromLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### ShipFromLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the address where the shipment originates. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### ShipFromPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address where the shipment originates. ### ShipFromState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the address where the shipment originates. ### ShipFromStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the address where the shipment originates. ### ShipToAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The physical address where the shipment is delivered. ### ShipToCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the address where the shipment is delivered. ### ShipToCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the address where the shipment is delivered. ### ShipToGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the address where the shipment is delivered. ### ShipToLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### ShipToLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the address where the shipment is delivered. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### ShipToName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The shipment recipient. ### ShipToPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address where the shipment is delivered. ### ShipToState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the address where the shipment is delivered. ### ShipToStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the address where the shipment is delivered. ### ShipmentNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number identifying the shipment. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the shipment originates. This is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the shipment. The picklist includes the following values, which can be customized: - Shipped—The product is in transit. - Delivered—The product is at the source location. ### TotalItemsQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total quantity of items included in the shipment. This value is calculated as the sum of the quantities of the shipment items in the shipment. ### TrackingNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The tracking number for the shipment. ### TrackingUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of the website used for tracking the shipment. # ShipmentItem Represents a product that’s included in a shipment. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the shipment item. ### ExpectedDeliveryDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Expected delivery date of the shipment that contains the shipment item. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the shipment item. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity of products represented by the shipment item. ### ReturnOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The return order line item associated with the shipment item that’s part of a return shipment. ### ShipmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The shipment that contains the shipment item. This field is a relationship field. - **Relationship Name**: Shipment - **Relationship Type**: Lookup - **Refers To**: Shipment ### ShipmentItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated number identifying the shipment item. ### TrackingNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The tracking number of the shipment that contains the shipment item. ### TrackingUrl - **Type**: url - **Properties**: Filter, Group, Nillable, Sort - **Description**: The tracking URL of the shipment that contains the shipment item. # StandardObjectNameChangeEvent A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events. ## Supported Calls describeSObjects() ## Special Access Rules - All objects may not be available in your org. Some objects require specific feature settings and permissions to be enabled. - For more special access rules, if any, see the documentation for the standard object. For example, for AccountChangeEvent, see the special access rules for Account. ## Change Event Support Change events are available for all custom objects and a subset of standard objects. Change events that correspond to custom settings are partially supported. They aren't supported in Apex triggers but are supported in other types of subscribers. For more information about standard object support, see the Objects That Support Change Events section below. ## Change Event Name The name of a change event is based on the name of the corresponding object for which it captures the changes. **Standard Object Change Event Name** ChangeEvent Example: AccountChangeEvent **Custom Object Change Event Name** \_\_ChangeEvent Example: MyCustomObject\_\_ChangeEvent ## Change Event Fields The fields that a change event can include correspond to the fields on the associated parent Salesforce object, with a few exceptions. For example, AccountChangeEvent fields correspond to the fields on Account. The fields that a change event doesn’t include are: - The IsDeleted system field. - The SystemModStamp system field. - Any field whose value isn’t on the record and is derived from another record or from a formula, except roll-up summary fields, which are included. Examples are formula fields. Examples of fields with derived values include LastActivityDate and PhotoUrl. Each change event also contains header fields. The header fields are included inside the ChangeEventHeader field. They contain information about the event, such as whether the change was an update or delete and the name of the object, like Account. In addition to the event payload, the event schema ID is included in the schema field. Also included is the event-specific field, replayId, which is used for retrieving past events. ## Event Message Example This example is an event message in JSON format for a new account record creation. { "schema": "IeRuaY6cbI\_HsV8Rv1Mc5g", "payload": { "ChangeEventHeader": { "entityName": "Account", "recordIds": \[ "" \], "changeType": "CREATE", "changeOrigin": "com/salesforce/api/soap/51.0;client=SfdcInternalAPI/", "transactionKey": "0002343d-9d90-e395-ed20-cf416ba652ad", "sequenceNumber": 1, "commitTimestamp": 1612912679000, "commitNumber": 10716283339728, "commitUser": "" }, "Name": "Acme", "Description": "Everyone is talking about the cloud. But what does it mean?", "OwnerId": "", "CreatedDate": "2021-02-09T23:17:59Z", "CreatedById": "", "LastModifiedDate": "2021-02-09T23:17:59Z", "LastModifiedById": "" }, "event": { "replayId": 6 } } ## API Version and Schema When you subscribe to change events, the subscription uses the latest API version and the event messages received reflect the latest field definitions. For more information, see [API Version and Event Schema](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_message_structure.htm#cdc_event_schema.htm) in the Change Data Capture Developer Guide. ## Usage For more information about Change Data Capture, see [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_intro.htm). ## Objects That Support Change Events These objects have associated ChangeEvent objects. - AccountForecast - AcctMgrTarget - AcctMgrTargetDstr - LeadLineItem - LeadPreferredSeller - OpportunityPreferredSeller - ProductBatchItem - ProductionBatch - SalesAgreement - SalesAgreementProduct # StandardObjectNameFeed StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object. The object name is variable and uses StandardObjectNameFeed syntax. For example, AccountFeed represents the posts and feed-tracked changes on an account record. We list the available associated feed objects at the end of this topic. For specific version information, see the documentation for the standard object. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules In the internal org, users can delete all feed items they created. This rule varies in Experience Cloud sites where threaded discussions and delete-blocking are enabled. Site members can delete all feed items they created, provided the feed items don’t have content nested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users with the Modify All Data permission can delete threads. To delete feed items they didn’t create, users must have one of these permissions: - Modify All Data - Modify All Records on the parent object, like Account for AccountFeed - Moderate Chatter ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note Users with the Moderate Chatter permission can delete only the feed items and comments they can see. Only users with this permission can delete items in unlisted groups. For more special access rules, if any, see the documentation for the standard object. For example, for AccountFeed, see the special access rules for Account. ## Fields ### BestCommentId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the comment marked as best answer on a question post. ### Body - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: The body of the post. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. ### CommentCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of comments associated with this feed item. ### ConnectionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization. ### InsertedById - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. ### isRichText - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using SOAP API, set IsRichText to true and escape HTML entities from the body. Otherwise, the post is rendered as plain text. Rich text supports the following HTML tags: -

Note: Though the
tag isn’t supported, you can use

 

to create lines. - - - - - - -
    -
      -
    1. - The tag is accessible only through the API and must reference files in Salesforce similar to this example: ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note In API version 35.0 and later, the system replaces special characters in rich text with escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-text representation. ### LikeCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of likes associated with this feed item. ### LinkUrl - **Type**: url - **Properties**: Nillable, Sort - **Description**: The URL of a LinkPost. ### NetworkScope - **Type**: picklist - **Properties**: Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available in the default Experience Cloud site, a specific Experience Cloud site, or all sites. This field is available in API version 26.0 and later, if digital experiences is enabled for your org. NetworkScope can have the following values: - NetworkId—The ID of the Experience Cloud site in which the FeedItem is available. If left empty, the feed item is only available in the default Experience Cloud site. - AllNetworks—The feed item is available in all Experience Cloud sites. Note the following exceptions for NetworkScope: - Only feed items with a Group or User parent can set a NetworkId or a null value for NetworkScope. - For feed items with a record parent, users can set NetworkScope only to AllNetworks. - You can’t filter a feed item on the NetworkScope field. ### ParentId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the record that is tracked in the feed. The detail page for the record displays the feed. ### RelatedRecordId - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the ContentVersion record associated with a ContentPost. This field is null for all posts except ContentPost. ### Title - **Type**: string - **Properties**: Group, Nillable, Sort - **Description**: The title of the feed item. When the Type is LinkPost, the LinkUrl is the URL and this field is the link name. ### Type - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of feed item. - **Possible values**: - ActivityEvent—indirectly generated event when a user or the API adds a [Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_task.htm#sforce_api_objects_task) associated with a feed-enabled parent record (excluding email tasks on cases). Also occurs when a user or the API adds or updates a Task or [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_event.htm#sforce_api_objects_event) associated with a case record (excluding email and call logging). For a recurring Task with CaseFeed disabled, one event is generated for the series only. For a recurring Task with CaseFeed enabled, events are generated for the series and each occurrence. - AdvancedTextPost—created when a user posts a group announcement and, in Lightning Experience as of API version 39.0 and later, when a user shares a post. - AnnouncementPost—Not used. - ApprovalPost—generated when a user submits an approval. - BasicTemplateFeedItem—Not used. - CanvasPost—a post made by a canvas app posted on a feed. - CollaborationGroupCreated—generated when a user creates a public group. - CollaborationGroupUnarchived—Not used. - ContentPost—a post with an attached file. - CreatedRecordEvent—generated when a user creates a record from the publisher. - DashboardComponentAlert—generated when a dashboard metric or gauge exceeds a user-defined threshold. - DashboardComponentSnapshot—created when a user posts a dashboard snapshot on a feed. - LinkPost—a post with an attached URL. - PollPost—a poll posted on a feed. - ProfileSkillPost—generated when a skill is added to a user’s Chatter profile. - QuestionPost—generated when a user posts a question. - ReplyPost—generated when Chatter Answers posts a reply. - RypplePost—generated when a user creates a Thanks badge in WDC. - TextPost—a direct text entry on a feed. - TrackedChange—a change or group of changes to a tracked field. - UserStatus—automatically generated when a user adds a post. Deprecated. ### Visibility - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies whether this feed item is available to all users or internal users only. This field is available if dgitial experiences is enabled for your org. Note the following exceptions for Visibility: - For record posts, Visibility is set to InternalUsers for all internal users by default. - External users can set Visibility only to AllUsers. - On user and group posts, only internal users can set Visibility to InternalUsers. - **Possible values**: - AllUsers—The feed item is available to all users who have permission to see the feed item. - InternalUsers—The feed item is available to internal users only. ## Usage A feed for an object is automatically created when a user enables feed tracking for the object. Use feeds to track changes to records. For example, AccountFeed tracks changes to an account record. Use feed objects to retrieve the content of feed fields, such as type of feed or feed ID. Note the following SOQL restrictions. No SOQL limit if logged-in user has the View All Data permission. If not, specify a LIMIT clause of 1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root object in the SOQL query. ## Object That Follows This Model This object follows the standard pattern for associated feed objects. - AcctMgrTargetFeed - ProductBatchItem - ProductionBatch # StandardObjectNameHistory StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object. The object name is variable and uses StandardObjectNameHistory syntax. For example, AccountHistory represents the history of changes to the values of an account record’s fields. We list the available associated history objects at the end of this topic. For specific version information, see the documentation for the standard object. ## Supported Calls describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for AccountHistory, see the special access rules for Account. ## Fields ### StandardObjectNameId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the standard object. ### Field - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Name of the field that was changed. ### NewValue - **Type**: anyType - **Properties**: Nillable, Sort - **Description**: New value of the field that was changed. ### OldValue - **Type**: anyType - **Properties**: Nillable, Sort - **Description**: Old value of the field that was changed. ## Objects That Follow This Model These objects follow the standard pattern for associated history objects. - AcctMgrTargetHistory - AcctMgrTargetDstrHistory - AcctMgrPeriodicTargetDstrHistory - GRNItemProductionBatch - GRNItemSerializedProduct - InventoryBatchItemReservation - InvItemInstanceReservation - PurchaseOrderItem - ProductBatchItem - ProductionBatch - ProductLaborCode - SalesAgreementProductHistory - SalesAgreementProductScheduleHistory # StandardObjectNameOwnerSharingRule StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner. The object name is variable and uses StandardObjectNameOwnerSharingRule syntax. For example, ChannelProgramOwnerSharingRule is a rule for sharing a channel program with users other than the channel program owner. We list the available associated owner sharing rule objects at the end of this topic. For specific version information, see the standard object documentation. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note To enable access to this object for your org, contact Salesforce customer support. However, we recommend that you instead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation. The [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_sharingrules.htm) Metadata API type is enabled for all orgs. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for ChannelProgramOwnerSharingRule, see the special access rules for ChannelProgram. ## Fields ### AccessLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Determines the level of access users have to records. Values are: - Read (read only) - Edit (read/write) ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the sharing rule. Maximum length is 1000 characters. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. ![Note](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. ### GroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the source group. Records that are owned by users in the source group trigger the rule to give access. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Label of the sharing rule as it appears in the UI. Maximum length is 80 characters. ### UserOrGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the user or group that you are granting access to. ## Objects That Follow This Model These objects follow the standard pattern for associated owner sharing rule objects. - ProductBatchItem - ProductionBatch - ProductItemAddlTrxn # StandardObjectNameShare StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. The object name is variable and uses StandardObjectNameShare syntax. For example, AccountBrandShare is a sharing entry on an account brand. We list the available associated share objects at the end of this topic. For specific version information, see the standard object documentation. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules For specific special access rules, if any, see the documentation for the standard object. For example, for AccountBrandShare, see the special access rules for AccountBrand. ## Fields ### AccessLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The level of access allowed. Values are: - All (owner) - Edit (read/write) - Read (read only) ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the parent record. ### RowCause - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Reason that the sharing entry exists. ### UserOrGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the user or group that has been given access to the object. ## Object That Follows This Model This object follows the standard pattern for associated share objects. - AcctMgrTargetShare - ProductBatchItem - ProductionBatch # StockRotationExecution Represents a stock rotation rebate activity, recording affected inventory and partner information for rebate claim processing. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### Account - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the partner account participating in the stock rotation execution. ### EligibleAmount - **Type**: currency - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the total amount the partner is eligible to claim under the stock rotation program. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the end date of the stock rotation execution. ### ExecutionReferenceNumber - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The reference number associated with the stock rotation execution process, such as a data processing engine definition. ### ProgramReference - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the reference object associated with the stock rotation execution. ### RebateProgram - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the rebate program associated with the stock rotation program. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the start date of the stock rotation execution. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates the current status of the stock rotation execution. Possible values: New, In-Progress, Completed, Closed, Canceled. ### TotalCalculatedAmount - **Type**: currency - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the total calculated amount for the partner under the stock rotation program. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Identifies the business process this execution record is used for (e.g., Stock Rotation Rebate, Rebate). # StockRotationExecutionItem Represents the affected partner inventory in a stock rotation rebate execution, used to determine claim eligibility. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AcceptedQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the quantity accepted for stock rotation in this line item. ### CalculatedAmount - **Type**: currency - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the simulated claim amount for this line item, calculated based on the claimable quantity. ### ClaimableQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the quantity eligible for claim under the stock rotation program. ### EligibleQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the quantity eligible for stock rotation in this line item. ### HasWarnings - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates whether this line item has any warnings. ### PartnerUnsoldInventory - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the partner’s unsold inventory eligible for stock rotation. ### PriceType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates the price category of the eligible inventory. ### Product - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the product from the partner’s eligible unsold inventory. ### ProgramRebateTypeEligibility - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the program rebate type detail associated with this line item. ### RebateClaim - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the rebate claim generated for this line item. ### RemainingQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the quantity remaining in the partner’s unsold inventory. ### SelectedDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the date when the quantity was selected for stock rotation. ### SelectedQuantity - **Type**: double - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the quantity selected for stock rotation in this line item. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Indicates the current status of the line item (e.g., New, Quantity Submitted, Accepted). ### StatusReason - **Type**: text - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the reason for the current status of the line item. ### StockRotationExecution - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the parent stock rotation execution record associated with this line item. ### StockRotationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the stock rotation method chosen by the partner (Return or Scrap). ### TransactionReference - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the reference object (e.g., Invoice/PUI) associated with this line item. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the unit price of the product in the eligible inventory. ### WarningMessage - **Type**: text - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the warning message associated with this line item if warnings exist. # Supplier Represents information about a supplier that a manufacturer procures product parts and components from. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account of the supplier. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the supplier. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the supplier. # SupplierProduct Represents information about a product that’s procured from a supplier. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the supplier product. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User # TelemetryActionDefinition Represents the action taken on a telemetry signal sent from a connected asset or vehicle, such as getting the current status of a vehicle or its component, or sending a request to perform a remote action on the vehicle or its component. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActionDefinition components have the suffix .TelemetryActionDefinition and are stored in the TelemetryActionDefinitions folder. ## Version TelemetryActionDefinition components are available in API version 65.0 and later. ## Fields ### actionName - **Field Type**: string - **Description**: Required. The full name of the action related to a telemetry definition. ### description - **Field Type**: string - **Description**: The description of the telemetry action definition. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### executionProcedure - **Field Type**: string - **Description**: The execution procedure that's used to fulfill telemetry action related processes. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the telemetry definition version is active (true) or not (false). - **Default value**: false ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActionDefinition, which is defined when the TelemetryActionDefinition is created. ### telemetryDefinitionVersion - **Field Type**: string - **Description**: Required. The telemetry definition version related to the action. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActionDefinition component. HoodStatusControl Action to monitor and control vehicle hood open/close status and switch operations HoodStatusControl HoodControlFlow true false Hood Status Control VehicleBodyMonitoringv1 The following is an example package.xml that references the previous definition. \* TelemetryActionDefinition 65.0 # TelemetryActionDefStep Represents a step in the action for a telemetry signal definition. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActionDefStep components have the suffix .TelemetryActionDefStep and are stored in the TelemetryActionDefSteps folder. ## Version TelemetryActionDefStep components are available in API version 65.0 and later. ## Fields ### delayInSeconds - **Field Type**: int - **Description**: Indicates a delay (in seconds) before the step is executed. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### groupName - **Field Type**: string - **Description**: Required. The name of the group that the telemetry action definition step belongs to. Steps in a group are shown together in an intake form. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActionDefStep, which is defined when the TelemetryActionDefStep is created. ### operationType - **Field Type**: TelemetryActnDefStepOpType (enumeration of type string) - **Description**: Required. Specifies the type of the operation that's performed in the telemetry action definition step. Values are: - Retrieve - Submit ### remoteEndPointUrl - **Field Type**: string - **Description**: The URL of the remote end point to which a request is shared to execute the telemetry action step. ### sequenceNumber - **Field Type**: int - **Description**: Required. The sequence number of a step in the action related to a telemetry definition. ### targetComponentPath - **Field Type**: string - **Description**: Required. The hierarchical path representing the target component in the telemetry system of a connected asset or vehicle where the action is targeted. ### telemetryActionDefinition - **Field Type**: string - **Description**: Required. The telemetry action definition related to the step. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActionDefStep component. 0 HoodStatusControl\_HoodPositionStep BodyControlResponse false Hood Position Monitor Submit https://api.sample-vehicle-management.com/hood Vehicle.Body.Hood HoodStatusControl The following is an example package.xml that references the previous definition. \* TelemetryActionDefStep 65.0 # TelemetryActnDefStepAttr Represents the attributes of a telemetry action definition step. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryActnDefStepAttr components have the suffix .TelemetryActnDefStepAttr and are stored in the TelemetryActnDefStepAttrs folder. ## Version TelemetryActnDefStepAttr components are available in API version 65.0 and later. ## Fields ### allowedValues - **Field Type**: string - **Description**: The allowed values for the telemetry action definition step attribute. ### attributeName - **Field Type**: string - **Description**: Required. The name of the telemetry action definition step attribute. ### dataType - **Field Type**: TelActnDefStepAttrDataType (enumeration of type string) - **Description**: Required. The data type of the telemetry action definition step attribute. Values are: - Boolean - Double - Float - Int16 - Int32 - Int8 - Integer - String - Uint16 - Uint32 - Uint64 - Uint8 ### description - **Field Type**: string - **Description**: The description of the telemetry action definition step attribute. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryActnDefStepAttr, which is defined when the TelemetryActnDefStepAttr is created. ### maximumValue - **Field Type**: double - **Description**: The maximum value allowed for the telemetry action definition step attribute. ### minimumValue - **Field Type**: double - **Description**: The minimum value allowed for the telemetry action definition step attribute. ### telemetryActnDefStep - **Field Type**: string - **Description**: Required. The telemetry action definition step that this attribute belongs to. ### type - **Field Type**: TelemetryActnDefStepAttrType (enumeration of type string) - **Description**: Required. The type of the telemetry action definition step attribute. Values are: - Actuator - Sensor ### unitOfMeasure - **Field Type**: string - **Description**: The unit of measure of the telemetry action definition step attribute. ## Declarative Metadata Sample Definition The following is an example of a TelemetryActnDefStepAttr component. INACTIVE,CLOSE,OPEN Position int8 sliding action such as window. HoodStatusControl\_HoodPositionStep\_Position false Hood Position Control HoodStatusControl\_HoodPositionStep Actuator Action The following is an example package.xml that references the previous definition. \* TelemetryActnDefStepAttr 65.0 # TelemetryDefinition Represents the definition of the structure of a telemetry signal sent from a connected asset or vehicle. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryDefinition components have the suffix .TelemetryDefinition and are stored in the TelemetryDefinitions folder. ## Version TelemetryDefinition components are available in API version 65.0 and later. ## Fields ### description - **Field Type**: string - **Description**: The description of the telemetry definition. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### isTemplate - **Field Type**: boolean - **Description**: Required. Indicates whether the telemetry definition is a template (true) or not (false). - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryDefinition, which is defined when the TelemetryDefinition is created. ### usageType - **Field Type**: TelemetryDefinitionUsageType (enumeration of type string) - **Description**: The usage type of the telemetry definition. - **Possible values**: - ConnectedAsset—Connected Asset - ConnectedVehicle—Connected Vehicle ## Declarative Metadata Sample Definition The following is an example of a TelemetryDefinition component. Telemetry definition for monitoring vehicle engine parameters including temperature, RPM, and fuel consumption VehicleEngineMonitoring false false VehicleEngineMonitoring ConnectedVehicle The following is an example package.xml that references the previous definition. \* TelemetryDefinition 65.0 # TelemetryDefinitionVersion Represents a version of the structure of a telemetry signal sent from a connected asset or vehicle. ## Parent Type This type extends the Metadata metadata type and inherits its fullName field. ## File Suffix and Directory Location TelemetryDefinitionVersion components have the suffix .TelemetryDefinitionVersion and are stored in the TelemetryDefinitionVersions folder. ## Version TelemetryDefinitionVersion components are available in API version 65.0 and later. ## Fields ### description - **Field Type**: string - **Description**: The description of the telemetry definition version. ### developerName - **Field Type**: string - **Description**: The developer’s internal name for the API. For example, if you create a record with MyCustomRecord name, you cannot create another record with that same name. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the telemetry definition version is active (true) or not (false). - **Default value**: false ### isProtected - **Field Type**: boolean - **Description**: An auto-generated value that doesn’t impact the behavior of the metadata type. - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. A user-friendly name for TelemetryDefinitionVersion, which is defined when the TelemetryDefinitionVersion is created. ### telemetryComponentStructure - **Field Type**: string - **Description**: The structure of the components in the telemetry definition that send signals, represented in a JSON format. ### telemetryDefinition - **Field Type**: string - **Description**: Required. The telemetry definition that's associated with the telemetry definition version. ### versionNumber - **Field Type**: int - **Description**: Required. The version number of the telemetry definition version. ## Declarative Metadata Sample Definition The following is an example of a TelemetryDefinitionVersion component. Initial version of vehicle engine monitoring telemetry definition VehicleEngineMonitoringv1 false false Vehicle Engine Monitoring v1.0 ewogICAgIlZlaGljbGUiOiB7CiAgICAgICAgImNoaWxkcmVuIjogewogICAgICAgICAgICAiQm9keSI6IHsKICAgICAgICAgICAgICAgICJjaGlsZHJlbiI6IHsKICAgICAgICAgICAgICAgICAgICAiSG9vZCI6IHsKICAgICAgICAgICAgICAgICAgICAgICAgImNoaWxkcmVuIjogewogICAgICAgICAgICAgICAgICAgICAgICAgICAgIlBvc2l0aW9uIjogewogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJjb21tZW50IjogIi4iLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJkYXRhdHlwZSI6ICJ1aW50OCIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkl0ZW0gcG9zaXRpb24uIDAgPSBTdGFydCBwb3NpdGlvbiAxMDAgPSBFbmQgcG9zaXRpb24uIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAibWF4IjogMTAwLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJtaW4iOiAwLAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJ0eXBlIjogImFjdHVhdG9yIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAidW5pdCI6ICJwZXJjZW50IgogICAgICAgICAgICAgICAgICAgICAgICAgICAgfSwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICJTd2l0Y2giOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgImFsbG93ZWQiOiBbCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJJTkFDVElWRSIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJDTE9TRSIsCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICJPUEVOIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIk9ORV9TSE9UX0NMT1NFIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIk9ORV9TSE9UX09QRU4iCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgXSwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiZGF0YXR5cGUiOiAic3RyaW5nIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAic2xpZGluZyBhY3Rpb24gc3VjaCBhcyB3aW5kb3cuIiwKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAidHlwZSI6ICJhY3R1YXRvciIKICAgICAgICAgICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgICAgICAgICAgfSwKICAgICAgICAgICAgICAgICAgICAgICAgImNvbW1lbnQiOiAiIiwKICAgICAgICAgICAgICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkhvb2Qgc3RhdHVzIiwKICAgICAgICAgICAgICAgICAgICAgICAgInR5cGUiOiAiYnJhbmNoIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0sCiAgICAgICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiQWxsIGJvZHkgY29tcG9uZW50cy4iLAogICAgICAgICAgICAgICAgInR5cGUiOiAiYnJhbmNoIgogICAgICAgICAgICB9CiAgICAgICAgfSwKICAgICAgICAiZGVzY3JpcHRpb24iOiAiSGlnaC1sZXZlbCB2ZWhpY2xlIGRhdGEuIiwKICAgICAgICAidHlwZSI6ICJicmFuY2giCiAgICB9Cn0= VehicleEngineMonitoring 1 The following is an example package.xml that references the previous definition. \* TelemetryDefinitionVersion 65.0 # Transformation Input Input representation for converting an input object type to an output object type. ## JSON Example { "inputObjectIds": \[ "0sTxx000000003FEAQ", "0sTxx000000004rEAA", "0sTxx0000000001EAA", "0sTxx000000001dEAA" \], "inputObjectName": "MfgProgramCpntFrcstFact", "usageType": "TransformationMapping", "outputObjectName": "Opportunity", "outputObjectDefaultValues": { "Opportunity": { "Pricebook2Id": "PriceBookID", "StageName": "Prospecting", "Probability": "20", "Name": "SampleFactToOpp", "CloseDate" : "2022-12-31" }, "OpportunityLineItem" : { "TotalPrice": 1234, "CurrencyIsoCode":"USD" // This is required in mutli currenct enabled org. }, "OpportunityLineItemSchedule": { "Type": "Both" // It's based on the product schedule enabled on setup. } } } ## Properties
      Name Type Description Required or Optional Available Version
      inputObjectIds String[] The list of record IDs for the input object type containing the mapping definition used to create the business transformation. The list of IDs must all be for the same object type. Required 55.0
      inputObjectName String The name of the input object containing the mapping definition used to create the business transformation. Possible values are:
      • MfgProgramCpntFrcstFact
      • ManufacturingProgram
      • MfgProgramCpntFrcstFact
      • Period
      • Quote
      • QuoteLineItem
      		 Required 55.0
      outputObjectDefaultValues Map<String, String>> The default values for the output object that are created from the input object IDs. Optional 55.0
      outputObjectName String The name of the output object that is created from the input object IDs. Required 55.0
      usageType String Usage type of the transformation. Possible values are:
      • ConvertToSalesAgreement
      • CLMFieldMapping
      • EligibleProgramRebateType
      • MapJournalToMemberAggregate
      • TransformationMapping
      		 Required 55.0
      # Transformation Output Represents the details of the transformation from source object to target object. ## JSON Example { "outputObjectDetails": \[ { "outputId": "Y\_id1", "inputIds": \[ "X\_id1", "X\_id2" \] } \], "errorDetails": \[ { "inputIds": \[ "X\_id3", "X\_id4" \], "errorReason": "Mandatory field1 missing value" } \], "Status" : "" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | outputObjectDetails | [Object Details Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_output_object_detail.htm "Represents the details of the transformation object.")\[\] | Provides information on the input and output IDs, error details, and the status of the transformation. | Small, 55.0 | 55.0 | | status | String | The status of the transformation request. | Small, 55.0 | 55.0 | # Transformations (POST) Perform the business transformation of program component forecast data (source object) to opportunities (target object). The following are some of the transformation scenarios: MfgProgramCpntFrcstFact to Opportunity, ManufacturingProgram to Opportunity, MfgProgramCpntFrcstFact to OpportunityLineItem, and Period to OpportunityLineItemSchedule. ## Resource /connect/manufacturing/transformations ## Resource Example https://yourInstance.salesforce.com/services/data/vXX.X/connect​/manufacturing/transformations ## Available Version 55.0 ## Requires Chatter No ## HTTP Methods POST ## Request Body for POST ### JSON Example { "inputObjectIds": \[ "0sTxx000000003FEAQ", "0sTxx000000004rEAA", "0sTxx0000000001EAA", "0sTxx000000001dEAA" \], "inputObjectName": "MfgProgramCpntFrcstFact", "usageType": "TransformationMapping", "outputObjectName": "Opportunity", "outputObjectDefaultValues": { "Opportunity": { "Pricebook2Id": "PriceBookID", "StageName": "Prospecting", "Probability": "20", "Name": "SampleFactToOpp", "CloseDate" : "2022-12-31" }, "OpportunityLineItem" : { "TotalPrice": 1234, "CurrencyIsoCode":"USD" // This is required in mutli currenct enabled org. }, "OpportunityLineItemSchedule": { "Type": "Both" // It's based on the product schedule enabled on setup. } } } ### Properties
      Name Type Description Required or Optional Available Version
      inputObjectIds String[] The list of record IDs for the input object type containing the mapping definition used to create the business transformation. The list of IDs must all be for the same object type. Required 55.0
      inputObjectName String The name of the input object containing the mapping definition used to create the business transformation. Possible values are:
      • MfgProgramCpntFrcstFact
      • ManufacturingProgram
      • MfgProgramCpntFrcstFact
      • Period
      • Quote
      • QuoteLineItem
      		 Required 55.0
      outputObjectDefaultValues Map<String, String>> The default values for the output object that are created from the input object IDs. Optional 55.0
      outputObjectName String The name of the output object that is created from the input object IDs. Required 55.0
      usageType String Usage type of the transformation. Possible values are:
      • ConvertToSalesAgreement
      • CLMFieldMapping
      • EligibleProgramRebateType
      • MapJournalToMemberAggregate
      • TransformationMapping
      		 Required 55.0
      ## Response Body for POST [Transformation Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_transformation.htm "Represents the details of the transformation from source object to target object.") # Update Account Manager Target Values Action Update an account manager target’s assignment values when the target’s value changes. The update is made based on the parent's target value and percentage. For more information about updating the assignment values of an account manager target, see [Use Manufacturing Actions in Flow Builder and Process Builder](https://help.salesforce.com/s/articleView?id=ind.admin_manufacturing_standard_invocable_actions.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This object is available in API version 49.0 and later for users with Manufacturing Cloud license. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/updateAcctMgrTarget **Formats:** JSON, XML **HTTP Methods:** GET, HEAD, POST **Authentication:** Authorization: Bearer token ## Inputs | Input | Type | Description | | --- | --- | --- | | entityId | ID | Required. The ID of the account manager target record. | ## Usage **Sample Request** The following example shows how to update account manager target: { “entityId”: “0gAT1000000006nMAA” } # Update Advanced Account Forecast Set Partner Action Updates the status of the Advanced Account Forecast Set Partner record after the forecast data for a given combination of account and forecast set has been generated. For more information about how the updateAdvancedAccountForecastSetPartner action updates the status, see [Calculate Account Forecasts Using Flows](https://help.salesforce.com/s/articleView?id=ind.admin_aaf_flow_calculate_acccount_forecasts.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. This object is available in API version 53.0 and later. ## Supported REST HTTP Methods **URI:** /services/data/vXX.X/actions/standard/updateAdvancedAccountForecastSetPartner **Formats:** JSON **HTTP Methods:** POST **Authentication:** Authorization: Bearer token ## Inputs
      Input Type Description
      accountId string The ID of an account record.
      forecastSetId string Required. The ID of the advanced account forecast set associated with the account.
      status string The status to be set for the Advanced Account Forecast Set Partner record.

      Possible values are:

      • Active
      • Inactive

      The status can be changed from Draft to Active or Active to Inactive.

      Note: When you don’t specify a status, by default the status of the Advanced Account Forecast Set Partner record is set from Draft to Active.
      ## Usage **JSON Sample Requests** This example sets the status for the Account Forecast Set Partner record with given forecast set ID and account ID to Active. { "inputs":\[{ "forecastSetId" : "0ni5sajb8347k3s", "accountId" : "001jsdhsdjo457", "status" : "Active" }\] } This example sets the status for all the Forecast Set Partner records with the given forecast set ID to Active. { "inputs":\[{ "forecastSetId" : "0ni5sajb8347k3s" }\] } This example sets the status for all the Forecast Set Partner records with the given forecast set ID to Inactive. { "inputs":\[{ "forecastSetId" : "0ni5sajb8347k3s", "status" : "Inactive" }\] } **JSON Sample Response** \[ { "actionName" : "updateAdvancedAccountForecastSetPartner", "errors" : null, "isSuccess" : true, "outputValues" : null } \] # Visit Represents information about a visit that a manager schedules for a field rep to perform, usually at distributor, supplier, and partner locations. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the visit. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ActualVisitEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit ended. ### ActualVisitStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit started. ### AddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The address associated with the visit. This field is a relationship field. - **Relationship Name**: Address - **Refers To**: Address ### ContactId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The contact associated with the visit. This field is a relationship field. - **Relationship Name**: Contact - **Refers To**: Contact ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The purpose of the visit. This field is a polymorphic relationship field. - **Relationship Name**: Context - **Refers To**: AcctMgrTarget, AdvAcctForecastSetPartner, AdvAcctForecastSetUse, Asset, Case, Claim, Data\_Processing\_Engine\_Node\_Metric\_\_c, ManufacturingProgram, RebateProgram, SalesAgreement, ServiceAppointment, Vehicle, omnistudio\_\_CardFrameworkConfiguration\_\_c, omnistudio\_\_DRBatchQueue\_\_c, omnistudio\_\_DRBulkData\_\_c, omnistudio\_\_DREncryption\_\_c, omnistudio\_\_DRWorker\_\_c, omnistudio\_\_Interface\_DRGeneric\_\_c, omnistudio\_\_TestResult\_\_c, omnistudio\_\_TriggerSetup\_\_c, omnistudio\_\_UISettings\_\_c, omnistudio\_\_VlocityDataPack\_\_c, omnistudio\_\_VlocityDocuSignTemplate\_\_c, omnistudio\_\_VlocityErrorLogEntry\_\_c, omnistudio\_\_VlocityScheduledJob\_\_c, omnistudio\_\_VlocityTrackingEntry\_\_c ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Currency of the sales agreement. - **Default value**: USD - **Possible values**: - ARS—Argentine Peso - AUD—Australian Dollar - BBD—Barbados Dollar - BHD—Bahraini Dinar - BMD—Bermuda Dollar - BRL—Brazilian Real - CAD—Canadian Dollar - CLP—Chilean Peso - CNY—Chinese Yuan - CRC—Costa Rica Colon - CZK—Czech Koruna - DKK—Danish Krone - DOP—Dominican Peso - EUR—Euro - FJD—Fiji Dollar - GBP—British Pound - GTQ—Guatemala Quetzal - HKD—Hong Kong Dollar - HRK—Kuna - HUF—Hungarian Forint - IDR—Indonesian Rupiah - ILS—Israeli Shekel - ISK—Iceland Krona - JPY—Japanese Yen - KYD—Cayman Islands Dollar - MXN—Mexican Peso - USD—U.S. Dollar - VND—Vietnam Dong - XCD—East Caribbean Dollar - XPF—Pacific Franc ### InstructionDescription - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Special instructions provided by a manager that the visitor refers to during a visit. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location of the supplier, distributor, or partner where the visit must be conducted. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identifier for the visit record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the visit record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent visit associated with the current visit. This field is a relationship field. - **Relationship Name**: ParentVisit - **Refers To**: Visit ### PlaceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the place that the visitor visits. This field is a polymorphic relationship field. - **Relationship Name**: Place - **Refers To**: Address, ContactPointAddress, Location ### PlannedVisitEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the visit is expected to end. ### PlannedVisitStartTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the visit is expected to start. ### ServiceResourceId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field is a relationship field. - **Relationship Name**: ServiceResource - **Refers To**: ServiceResource ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the visit. Visitors can’t edit this field. The default value is Planned. - **Default value**: Planned - **Possible values**: - Abandoned - Completed - Error - InProgress—In Progress - None - Planned - Unscheduled ### StatusRemarks - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reasons for abandoning or completing the visit as provided by the visitor. ### UserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The user associated with the visit. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User ### VisitPriority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the visit. - **Possible values**: - High - Low - Medium ### VisitTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of visit such as inspection type, or work type. This field is a polymorphic relationship field. - **Relationship Name**: VisitType - **Refers To**: WorkType ### VisitorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the person visiting the place. This field is a polymorphic relationship field. - **Relationship Name**: Visitor - **Refers To**: Contact, ServiceResource, User # Warranty To Supplier Claims (POST) Warranty to Supplier Claims API clones the existing warranty claim and its hierarchy such as claim items, claim coverage, and claim coverage payment details. ## Resource /connect/warranty/supplier-claim ## Available Version 61.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "claimIds":\["0ZkSB00000002TF0AY"\], "contextDefinition":"ClaimDetails\_\_stdctx", "contextMapping":"ClaimDetailsMapping", "conversionType":"Supplier Recovery Claim", "supplierRecoveryProducts":\[{"product2Id":"01tSB000000PXLlYAO","salesContractLineId":"0sLSB00000001Ab2AI"}\] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimIds | String\[\] | The IDs of the claim records of the claim type Warranty Claim. | Required | 61.0 | | contextDefinition | String | The developer name of the context definition that contains the structure of a warranty claim. | Optional | 61.0 | | contextMapping | String | The name of the context mapping associated with the context definition. | Optional | 61.0 | | conversionType | String | The type of conversion. | Optional | 61.0 | | supplierRecoveryProducts | Supplier Recovery Contract Input \[\] | The products associated with the supplier recovery claim. | Optional | 61.0 | ## Response Body for POST [Warranty To Supplier Claims Output](https://developer.salesforce.com/docs/atlas.en-us.mfg_api_devguide.meta/mfg_api_devguide/connect_responses_warranty_to_supplier_claims.htm "Output representation with the supplier recovery claims created from warranty claims.") # Warranty To Supplier Claims Input Input representation to create supplier recovery claims from warranty claims. ## JSON Example { "claimIds":\["0ZkSB00000002TF0AY"\], "contextDefinition":"ClaimDetails\_\_stdctx", "contextMapping":"ClaimDetailsMapping", "conversionType":"Supplier Recovery Claim", "supplierRecoveryProducts":\[{"product2Id":"01tSB000000PXLlYAO","salesContractLineId":"0sLSB00000001Ab2AI"}\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimIds | String\[\] | The IDs of the claim records of the claim type Warranty Claim. | Required | 61.0 | | contextDefinition | String | The developer name of the context definition that contains the structure of a warranty claim. | Optional | 61.0 | | contextMapping | String | The name of the context mapping associated with the context definition. | Optional | 61.0 | | conversionType | String | The type of conversion. | Optional | 61.0 | | supplierRecoveryProducts | Supplier Recovery Contract Input \[\] | The products associated with the supplier recovery claim. | Optional | 61.0 | ## Properties of Supplier Recovery Contract Input
      Name Type Description Required or Optional Available Version
      product2Id String The ID of the product that’s the causal part in the claim coverage. This product is a part of the supplier recovery contract. Required if Supplier Recovery Contract Input property is passed in Connect API. 61.0
      salesContractLineId String The ID of the sales contract line for supplier recovery.

      The sales contract line is created if the product it contains is the same as the product that's specified in the Product object.

      		 Required if Supplier Recovery Contract Input property is passed in Connect API. 61.0
      # Warranty To Supplier Claims Output Output representation with the supplier recovery claims created from warranty claims. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | supplierClaimsIds | String\[\] | The IDs of the claim records of the claim type Supplier Recovery Claim. | Small, 61.0 | 61.0 | # WarrantyTerm Represents warranty terms defining the labor, parts, and expenses covered, along with any exchange options, provided to rectify issues with products. This object is available in Manufacturing Cloud in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code or other identifier associated with this warranty term. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the warranty term. ### EffectiveStartDate - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the warranty term became available for use. - **Possible values**: - Install Date - Manufacture Date - Purchase Date ### ExchangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of exchange offered. - **Possible values**: - Advance Exchange - Loaner - Return Exchange ### Exclusions - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of any exclusions. ### ExpensesCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of expenses covered. ### ExpensesCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which expenses are covered. ### ExpensesCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which expenses covered duration is measured. - **Possible values**: - Days - Months - Weeks - Years ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the warranty term is active (true) or not (false). - **Default value**: false ### IsTransferable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the warranty can be transferred to a new owner (true) or not (false). - **Default value**: false ### LaborCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of labor covered. ### LaborCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which labor is covered. ### LaborCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which labor covered duration is measured. - **Possible values**: - Days - Months - Weeks - Years ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the warranty term was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the warranty term was last viewed. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The warranty term’s assigned owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartsCovered - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of parts covered. ### PartsCoveredDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for which parts are covered. ### PartsCoveredUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The unit in which parts covered duration is measured. - **Possible values**: - Days - Months - Weeks - Years ### Pricebook2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the price book item associated with this warranty term. This field is a relationship field. - **Relationship Name**: Pricebook2 - **Relationship Type**: Lookup - **Refers To**: Pricebook2 ### UsageCovered - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product usage that's covered in the warranty term. ### UsageCoveredUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the product usage. This field is a relationship field. - **Relationship Name**: UsageCoveredUom - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### WarrantyDuration - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The duration of the warranty offered by this term. ### WarrantyTermName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the warranty term. ### WarrantyType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of warranty. - **Possible values**: - Repair - Standard - Supplier ### WarrantyUnitOfTime - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The unit in which the warranty duration is measured. - **Possible values**: - Days - Months - Weeks - Years # WarrantyTermCoverage Represents a junction between the warranty term coverage and a product or codeset, such as the repair code or labor code. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CoveredCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The labor code or expense code that's associated with the coverage for the warranty term. This field is a relationship field. - **Relationship Name**: CoveredCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### IsExcluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product, labor code, or fault code is excluded from the warranty term (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autogenerated name of the warranty term coverage. ### ProductPartId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The part of the product that's covered in the warranty term. This field is a relationship field. - **Relationship Name**: ProductPart - **Relationship Type**: Lookup - **Refers To**: Product2 ### WarrantyTermId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The warranty term associated with the product, fault, or labor code. This field is a relationship field. - **Relationship Name**: WarrantyTerm - **Relationship Type**: Lookup - **Refers To**: WarrantyTerm # WorkOrderDiagnosis Represents the diagnosis details of the Work Order that the user records during depot repair. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### WorkOrder - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The work order associated with the diagnosis. ### WorkOrderLineItem - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The work order line item associated with the diagnosis. ### FaultCode - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The fault code associated with the asset or product. ### CausalPart - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The part of the asset or product causing the fault. ### Diagnosis - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: The details of the fault or issue that's being diagnosed. ### Solution - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: The details about the solution to fix the fault.