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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "OrderAdjustmentGroupSummary - Data API",
  "description": "Represents the current properties and state of a group of related price adjustments. Associated with a set of OrderItemAdjustmentLineSummaries that apply to OrderItemSummaries belonging to one OrderSummary. Corresponds to one or more order adjustment group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AdjustmentBasisReferenceId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "References the specific coupon applied. This is a polymorphic relationship field.",
      "relationship_name": "AdjustmentBasisReference",
      "relationship_type": "Lookup",
      "refers_to": "Coupon"
    },
    "AdjustmentCauseId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "References the specific promotions applied. This is a polymorphic relationship field.",
      "relationship_name": "AdjustmentCause",
      "relationship_type": "Lookup",
      "refers_to": "Promotion"
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
      "description": "ISO code for the currency of the OrderSummary associated with the adjustments in the group. The default value is USD. Possible values are: DKK—Danish Krone EUR—Euro GBP—British Pound USD—U.S. Dollar This field is available in API version 49.0 and later."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Description of the OrderAdjustmentGroupSummary. This field can be edited."
    },
    "GrandTotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Total, including tax, of the associated OrderItemAdjustmentLineSummaries."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "Name of the OrderAdjustmentGroupSummary."
    },
    "OrderSummaryId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the OrderSummary associated with the OrderAdjustmentGroupSummary."
    },
    "OriginalOrderAdjGroupId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "ID of the original OrderAdjustmentGroup associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false."
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Total, not including tax, of the associated OrderItemAdjustmentIineSummaries."
    },
    "TotalTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Tax on the TotalAmount."
    },
    "Type": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Type of the OrderAdjustmentGroupSummary. Header represents an order-level adjustment with an OrderItemAdjustmentLineSummary for each OrderItemSummary on the OrderSummary. SplitLine represents any other related set of OrderItemAdjustmentLineSummaries. Possible values are: Header SplitLine If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field."
    }
  },
  "special_access_rules": "This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled.",
  "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.\n\n- **OrderAdjustmentGroupSummaryChangeEvent (API version 62.0)**: Change events are available for the object.",
  "field_reference": {
    "AdjustmentBasisReferenceId": {
      "field_label": "Adjustment Basis Reference ID",
      "type": "reference",
      "length": "18"
    },
    "AdjustmentCauseId": {
      "field_label": "Adjustment Cause ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "2000"
    },
    "GrandTotalAmount": {
      "field_label": "Total with Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Id": {
      "field_label": "Order Adjustment Group Summary ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OrderSummaryId": {
      "field_label": "Order Summary ID",
      "type": "reference",
      "length": "18"
    },
    "OriginalOrderAdjGroupId": {
      "field_label": "Order Adjustment Group ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalAmount": {
      "field_label": "Pretax Total",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalTaxAmount": {
      "field_label": "Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Type": {
      "field_label": "Type",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}