Transaction Management Fields on Order Item

Standard and custom fields extend the standard Order Item object for use in Transaction Management.

Special Access Rules 

These fields require the Revenue Cloud Advanced license. See Order Item for fields on the Salesforce platform object.

Fields 

ApplUnitPriceUpliftPct 

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The unit price uplift percent that’s applied to the order item, used for ramp pricing.

This field is available in API version 68.0 and later.

CustomProductName 

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The custom name of a product that’s used to override the product name. The maximum supported length is 80 characters. Available in API version 61.0 and later.

Discount 

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The manual discount percentage for the order item. Available in API version 60.0 and later.

DiscountAmount 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The manual discount amount for the order item. Available in API version 60.0 and later.

EffectiveGrantDate 

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date when the resources associated with the order item are granted.

EndDateTime 

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The end date and time of the order item, which is calculated by using the values in the EndDate, EndTime, and ServiceEndTimeZone fields.

If the EndTime field doesn’t have a value, 23:59:59 is used for the calculation. If the ServiceEndTimeZone field doesn’t have a value, GMT is used for the calculation.

Available in API version 65.0 and later.

EndQuantity 

Type: double

Properties: Filter, Nillable, Sort

Description: The revised quantity of the item after adjusting changes. The field is read-only. It’s calculated by adding the Start Quantity and the Quantity fields. Available in API version 60.0 and later.

EndTime 

Type: time

Properties: Create, Filter, Nillable, Sort, Update

Description: The end time of the order item. Available in API version 65.0 and later.

Margin 

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The optional margin percentage, specified by the sales representative at the line item level. Available in API version 65.0 and later.

MarginAmount 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The optional margin amount specified by the sales representative at the line item level. Available in API version 65.0 and later.

NetTotalPrice 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The total price after applying all price adjustments. Available in API version 60.0 and later.

OrderItemGroupId 

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The order item group associated with the order item.

This field is a relationship field.

Relationship Name: OrderItemGroup

Refers To: OrderItemGroup

PartnerDiscountPercent 

Type: percent

Properties: Create, Filter, Nillable, Sort, Update

Description: The discount percentage given to the partner for the order item. Available in API version 60.0 and later.

PartnerUnitPrice 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The unit price after applying the discount given to the partner for the order item. Available in API version 60.0 and later.

PriceWaterfallIdentifier 

Type: string

Properties: Filter, Group, Nillable, Sort

Description: The price waterfall identifier generated by Salesforce Pricing that’s associated with the pricing of this order item record. Available in API version 60.0 and later.

RampUpliftType 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The pricing uplift calculation type for ramp segments.

Valid values are:

  • Compound
  • Standard

This field is available in API version 68.0 and later.

SegmentType 

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The duration type of the segment. You can use this field from Revenue Management only when the Ramp Deals for Groups in Quotes and Orders setting is turned on.

Valid values are:

  • Custom—Available in API version 65.0 and later.
  • Prorated—Available in API version 67.0 and later.
  • Trial—Available in API version 67.0 and later.
  • Yearly—Available in API version 65.0 and later.

The default value is Yearly.

ServiceDateTime 

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The start date and time of the order item, which is calculated by using the values in the ServiceDate, ServiceTime, and ServiceEndTimeZone fields.

If the ServiceTime field doesn’t have a value, 00:00:00 is used for the calculation. If the ServiceEndTimeZone field doesn’t have a value, GMT is used for the calculation.

Available in API version 65.0 and later.

ServiceEndTimeZone 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The time zone for the order item’s start and end dates, times, and datetimes. Available in API version 65.0 and later.

ServiceTime 

Type: time

Properties: Create, Filter, Nillable, Sort, Update

Description: The start time of the order item. Available in API version 65.0 and later.

StartQuantity 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The quantity available on the order item start date. Available in API version 60.0 and later.

Status 

Type: picklist

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The status of the order item. Available in API version 60.0 and later.

SubscriptionTerm 

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The number of terms in the subscription for the item.

The unit of the subscription term is stored in the PricingTermUnit field of this order item’s related product selling model record (OrderItem.ProductSellingModel.PricingTermUnit). Available in API version 61.0 and later.

SupplementalChangeType 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies the order item change type in the supplemental order.

Possible values are:

  • Add
  • Amend
  • Cancel
  • No Change

This field is available in API version 64.0 and later.

TotalAdjustment 

Type: percent

Properties: Filter, Nillable, Sort

Description: The total discount percentage applied at the line item level. This percentage is calculated by using the formula: (Total Line Amount - Net Total Price) / Total Line Amount. Available in API version 65.0 and later.

TotalCost 

Type: currency

Properties: Filter, Nillable, Sort

Description: The total cost of all products sold in the order is calculated by multiplying the quantity by the unit cost. Available in API version 65.0 and later.

TotalMargin 

Type: percent

Properties: Filter, Nillable, Sort

Description: The effective margin percentage at the line item level. This percentage is calculated by using the formula: (Net Total Price - Total Cost) / Net Total Price. Available in API version 65.0 and later.

TotalMarginAmount 

Type: currency

Properties: Filter, Nillable, Sort

Description: The effective margin amount at the line item level. This amount is calculated by subtracting total cost from net total price. Available in API version 65.0 and later.

UnitCost 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The unit cost of a product sold as part of the order. Available in API version 65.0 and later.

ValidationResult 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies whether the order item was configured and priced.

An order can be activated only after all its order items are configured and priced.

Valid value is Warning—Indicates that the order item isn’t configured and priced. Available in API version 60.0 and later.