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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules"
  ],
  "title": "PriceAdjustmentItemShape - Data API",
  "description": "Defines the business logic for an item-level price adjustment, for example, a discount on an order item. This object is available in API version 57.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AdjustmentAmountScope": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Used with AdjustmentValue to determine the amount of the adjustment. Possible values are: Total—The adjustment applies to the line item's total and isn’t multiplied by the quantity.For example, let's say a sales transaction item quantity is 10 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of -10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Total, the $10 discount is applied to the total line amount. The TotalAmount of the price adjustment item is $1000 + (-$10) = $990. Unit—The adjustment is multiplied by the line item’s quantity.For example, let's say a sales transaction item quantity is 5 and the TotalLineAmount is 1000. If the price adjustment item has an AdjustmentValue of -10, an AdjustmentType of AdjustmentAmount, and an AdjustmentAmountScope of Unit, the $10 discount is applied to each line amount. The TotalAmount of the price adjustment item is $1000 + (-$10 x 5) = $950. UnproratedTotal—No adjustment is applied to the line items."
    },
    "AdjustmentSource": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the source of the adjustment. Possible values are: Discretionary— The adjustment is entered manually; for example, by a sales rep. Promotion— The adjustment is a promotion. Rule— Reserved for future use. System— The adjustment is determined by the pricing configuration for the product; for example, as part of a discount schedule."
    },
    "AdjustmentType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates whether the adjustment is a percentage, an amount, or an override. Possible values are: AdjustmentAmount—The adjustment value is a numerical amount. AdjustmentPercentage— The adjustment value is a percentage. OverrideAmount— The override value is a numerical amount."
    },
    "AdjustmentValue": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The value of the adjustment. Used together with AdjustmentAmountScope to determine the amount of the adjustment."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable",
      "description": "The user-entered description of the price adjustment item. Available in API version 57.0."
    },
    "PriceAdjustmentCauseId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the record that caused the adjustment. For example, if the price adjustment is due to a promotion, this field contains the ID of the Promotion record. If the price adjustment is due to a price adjustment tier, this field contains the ID of the PriceAdjustmentTier record. This field is a polymorphic relationship field.",
      "relationship_name": "PriceAdjustmentCause",
      "relationship_type": "Lookup",
      "refers_to": "PriceAdjustmentTier"
    },
    "PriceAdjustmentGroupShapeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "A reference to the object interface or object that summarizes the values from multiple price adjustment items. If the related entity is an object, the object must implement the PriceAdjustmentGroupShape object. This field is a relationship field.",
      "relationship_name": "PriceAdjustmentGroupShape",
      "relationship_type": "Lookup",
      "refers_to": "PriceAdjustmentGroupShape"
    },
    "PriceAdjustmentItemShapeName": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort",
      "description": "The name of the price adjustment item shape."
    },
    "Priority": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "A positive integer indicating the order in which this price adjustment item is applied, relative to other price adjustment items. A Priority of 1 indicates this price adjustment item is applied first. Price adjustments with a null priority are applied after price adjustments with a specified priority. If two or more price adjustments have a null priority, percentage adjustments are applied before amount adjustments. Applying a percentage adjustment before an amount adjustment results in a larger total adjustment. Note: The value of Priority must be unique among price adjustment items related to the same price adjustment group. For example, you can’t have two price adjustment items with a priority of 1. For example, let’s say that two price adjustment items apply to the same item to be priced. The first price adjustment, Spring_Promotion, defines a 10% discount and has Priority of 1. The second price adjustment, Early_Renewal_Discount, defines a $2,000 discount and has a Priority of 2. In this case, the Spring_Promotion price adjustment is applied before the Early_Renewal_Discount price adjustment."
    },
    "SalesTransactionItemShapeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of the sales transaction shape item that the price adjustment item applies to. This field is a relationship field.",
      "relationship_name": "SalesTransactionItemShape",
      "relationship_type": "Lookup",
      "refers_to": "SalesTransactionItemShape"
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The total amount of the adjustment that applies to the item to be priced, inclusive of quantity, prorated for the duration of the subscription.For example, let’s say the price adjustment item has an AdjustmentAmountScope of Unit, an AdjustmentType of AdjustmentAmount, and an AdjustmentValue of -10. This configuration indicates a $10 per-unit discount. If the subscription is priced for 12 months and the pricing term is 1, the PricingTermCount on the sales transaction item is 12. If the quantity is 5, the value of TotalAmount is 5 x 12 x -10 = -600"
    }
  },
  "special_access_rules": "This object is available with Subscription Management, B2B Commerce, or B2C Commerce."
}