afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/SalesTransactionShape.json

59 lines
3.3 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules"
],
"title": "SalesTransactionShape - Data API",
"description": "Defines the business logic for a sales transaction; for example, an order, a quote, or a cart. This object is available in API version 57.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AccountId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The unique identifier for the account associated with this sales transaction shape. This field is available when OrgPermissions or Platform is enabled. This field is a relationship field.",
"relationship_name": "Account",
"relationship_type": "Lookup",
"refers_to": "Account"
},
"SalesTransactionShapeName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort",
"description": "The name of the sales transaction shape. For example, Quote."
},
"TotalAdjustmentAmount": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort",
"description": "The sum of all adjustments applied to the sales transaction shape, inclusive of quantity, prorated for the duration of the subscription. Includes distributed price adjustment items and price adjustment items applied directly. This calculated field is equal to the sum of TotalAdjustmentAmount on the related sales transaction shape items."
},
"TotalAdjustmentDistAmount": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort",
"description": "The sum of the distributed price adjustment items applied to the related sales transaction shape items, inclusive of quantity, prorated for the duration of the subscription. Does not include price adjustment items that are applied directly. This calculated field is equal to the sum of TotalAdjustmentDistAmount on the related sales transaction shape items."
},
"TotalAmount": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort",
"description": "The final price of the sales transaction shape, after all adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field equal to the sum of TotalPrice on the related sales transaction shape items."
},
"TotalListAmount": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort",
"description": "The sum of the list price of the related sales transaction shape items, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to the sum of ListPriceTotal on the related sales transaction shape items."
},
"TotalProductAmount": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort",
"description": "The total price of all related sales transaction shape items of type Product, before price adjustments, inclusive of quantity, prorated for the duration of the subscription. This calculated field is equal to the sum of TotalLineAmount on the related sales transaction shape items of type Product."
}
},
"special_access_rules": "This object is available with Subscription Management, B2B Commerce, or B2C Commerce."
}