Newer Version Available

This content describes an older version of this product. View Latest

Sales Agreement

Create a sales agreement from an external source, including quote, opportunity, or custom object.
Resource
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.
Request body for POST
JSON example
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.

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

Note

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

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 metadata type for the mapping definition from Opportunity to SalesAgreement (parent level mapping) and OpportunityLineItem to SalesAgreementProduct (child level mapping).