Newer Version Available

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

OrderItemTaxLineItemSummary

Represents the current tax on an OrderItemSummary or OrderItemAdjustmentLineSummary. Corresponds to one or more order item tax line items, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update()

Special Access Rules

This object is only available in Salesforce Order Management orgs or if the B2B Commerce on Lightning Experience license is enabled.

Fields

Field Details
Amount
Type
currency
Properties
Filter, Sort
Description
Amount of tax represented by the OrderItemTaxLineItemSummary.
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.
CurrencyIsoCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
ISO code for the currency of the OrderSummary associated with the OrderItemTaxLineItemSummary. 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
Nillable, Update
Description
Description of the OrderItemTaxLineItemSummary.
This field can be edited.
Name
Type
string
Properties
Filter, Group, idLookup, Sort, Update
Description
Name of the OrderItemTaxLineItemSummary.
OrderItemAdjustmentLine​SummaryId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
If this object represents tax on an adjustment, this value is the ID of the OrderItemAdjustmentLineSummary to which the tax applies. If this value is null, the adjustment applies to an OrderItemSummary.
OrderItemSummaryId
Type
reference
Properties
Filter, Group, Sort
Description
If this object represents tax on an OrderItemSummary, this value is the ID of that OrderItemSummary. If this object represents tax on an adjustment, this value is the ID of the OrderItemSummary to which the adjustment applies.
OrderSummaryId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the OrderSummary that the associated OrderItemSummary or OrderItemAdjustmentLineSummary belongs to.
OriginalOrderItemTax​LineItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the original order item tax line item associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false.
Rate
Type
percent
Properties
Filter, Nillable, Sort
Description
Tax rate used to calculate the Amount.
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.
TaxEffectiveDate
Type
date
Properties
Filter, Group, Sort
Description
Date on which the Amount was calculated. Important due to tax rate changes over time.
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.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Indicates whether the Amount is actual or estimated.
Possible values are:
  • Actual
  • Estimated
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.