| BasisTransactionItemId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the transaction item to use as a reference when pricing
this transaction.
For example, let’s say an order item is
renewed. In this case, a renewal order item is created from the
new sale order item, and the
BasisTransactionItemId on the new sale
order item is updated to contain the ID of the renewal order
item.
- This field is a polymorphic relationship field.
- Relationship Name
- BasisTransactionItem
- Relationship Type
- Lookup
- Refers To
- SalesTransactionItem
|
| BillingFrequency |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The time period that indicates how often the sales transaction
item is billed.
- Possible values are:
|
| EndDate |
- Type
- date
- Properties
- Filter, Group, Nillable, Sort
- Description
- The last day the sales transaction item is available. For example,
the last day that the service purchased in the order item is
available.
|
| ImplementorType |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The object that is implementing this entity interface, for
example, an OrderProduct object.
|
| ListPrice |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The list price for the sales transaction item. This value is
inherited from the related price book entry.
|
| ListPriceTotal |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The list price, inclusive of quantity, prorated for the duration
of the subscription. This calculated field is equal to
ListPrice times
Quantity times
PricingTermCount.
|
| NetUnitPrice |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The unit price after all adjustments are applied.
|
| ObligatedAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- In a subscription, the amount a subscriber is billed for products
used during the subscription period that the subscriber returns
before the subscription end date. This field's value is the price
for use of the product.
- This field is available in version 57.0 and later. This field is
available when Subscription Management is enabled.
-
- A subscriber must submit a quantity amendment in order to
change the subscription's product quantity. A quantity
amendment request is only valid until the subscription end
date.
- A subscriber is eligible for a refund only for the
periods when the products weren’t used.
- The subscription's proration policy indicates whether the
obligated amount and the refund are prorated for partial
periods.
|
| ParentSalesTransactionItem |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The parent transaction of
BasisTransactionItemId. This field is
available in API version 58.0 and later. This field is a
polymorphic relationship field.
- Relationship Name
- ParentSalesTransactionItem
- Relationship Type
- Lookup
- Refers To
- SalesTransactionItem
|
| PeriodBoundary |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The period boundary helps determine the start and end date of the
billing periods.
- Possible values are:
-
AlignToCalendar—The period starts on the
first day of the term unit, for example, the first day of the
month.
-
Anniversary—The
start date determines the boundary. For example, if a monthly
subscription starts on September 13, the subscription starts
on the 13th day of each month.
-
DayOfPeriod—The
period starts on the day indicated by
PeriodBoundaryDay.
-
LastDayOfPeriod—The period starts on the
last day of the pricing term unit; for example, the last day
of the month.
|
| PeriodBoundaryDay |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Required when PeriodBoundary is DayOfPeriod. Indicates day of the
week or month that marks the period boundary. Must be an integer
from 1 through 31.
|
| PeriodBoundaryStartMonth |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Nillable, Sort,
Update
- Description
- Field is populated based on input in the StartDate,
PeriodBoundary, and PeriodBoundaryDay when BillingFrequency is
Annual or by manual user entry. Possible values are:
- 1-January
- 2-February
- 3-March
- 4-April
- 5-May
- 6-June
- 7-July
- 8-August
- 9-September
- 10-October
- 11-November
- 12-December
|
| PricebookEntryId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The unique identifier of the related price book entry.
- This field is a relationship field.
- Relationship Name
- PricebookEntry
- Relationship Type
- Lookup
- Refers To
- PricebookEntryInterface
|
| PricingTermCount |
- Type
- double
- Properties
- Filter, Nillable, Sort
- Description
- A calculated field indicating the number of pricing terms in the
subscription.
|
| PricingTransactionType |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates the type of pricing transaction, for example, a new
sale, a cancellation, an amendment, or a renewal.
- Possible values are:
-
AmendmentAtLastNegotiatedPrice—calculate
the price of the amended sales transaction item using the
same price book and price adjustments as the new sale item.
For example, an order item that is amended using a pricing
transaction type of AmendmentAtLastNegotiatedPrice is priced using
the same price book information and price adjustments as the
new sale item. The amended order item has the same price as
the new sale order item. This value is available in version
57.0 and later.
-
AmendmentStartingFromListPrice—calculate
the price of the amended sales transaction item using current
price book information, disregarding any pricing information
or adjustments that were applied to the new sale item.
Typically, an amended transaction item has a different price
than the new sale transaction item. This value is available
in version 57.0 and later.
-
Cancellation—calculate the price of the
canceled transaction. For example, let’s say that a 1-year
subscription was purchased on January 1, then canceled on
July 31. The price of the canceled products and services from
August 1 through Dec 31 is calculated.
-
NewSale—the
price of a new transaction is calculated.
-
RenewalAtLastNegotiatedPrice—calculate
the price of the renewal transaction item using the same
price book and price adjustments as the new sale item. For
example, an order item that is renewed using a pricing
transaction type of RenewalAtLastNegotiatedPrice is priced using the
same price book information and price adjustments as the new
sale item. The renewal order item has the same price as the
new sale order item.
-
RenewalAtListPrice—calculate the price of
the renewal transaction item using current price book
information, disregarding any pricing information or
adjustments that were applied to the new sale item.
Typically, a renewal transaction item has a different price
than the new sale transaction item.
|
| ProductId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- ID of the related product.
- This field is a relationship field.
- Relationship Name
- Product
- Relationship Type
- Lookup
- Refers To
- ProductInterface
|
| ProductSellingModelId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the related product selling model. The product selling
model defines one method by which a product can be sold, for
example, as a one-time sale, an evergreen subscription, or a termed
subscription.
- This field is a relationship field.
- Relationship Name
- ProductSellingModel
- Relationship Type
- Lookup
- Refers To
- ProductSellingModel
|
| ProrationPolicyId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the related proration policy. The proration policy
defines how the price is calculated for each subscription period,
for example, whether partial periods are allowed, and how remainder
amounts are handled.
- This field is a relationship field.
- Relationship Name
- ProrationPolicy
- Relationship Type
- Lookup
- Refers To
- ProrationPolicy
|
| Quantity |
- Type
- double
- Properties
- Filter, Sort
- Description
- Required. Number of units in the sales transaction item.
|
| SalesItemType |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Required. The type of sale.
- Possible values are:
|
| SalesTransactionId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the related sales transaction.
- This field is a polymorphic relationship field.
- Relationship Name
- SalesTransaction
- Relationship Type
- Lookup
- Refers To
- SalesTransaction
|
| StartDate |
- Type
- date
- Properties
- Filter, Group, Nillable, Sort
- Description
- The start date of the service or charge.
|
| StartingPriceTotal |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The starting unit price, inclusive of quantity, prorated for the
duration of the subscription. This calculated field is equal to
StartingUnitPrice times
Quantity times
PricingTermCount.
|
| StartingUnitPrice |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The unit price before any adjustments.
|
| StartingUnitPriceSource |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Required. Indicates whether the starting unit price was inherited,
entered manually, or calculated.
- Possible values are:
-
Inherited—The
starting unit price is copied from a previous transaction,
for example, from the order item being renewed.
-
Manual—The
starting unit price is entered manually, for example, by a
sales rep.
-
System—The
starting unit price is calculated using pricing information
that was configured by an administrator, for example, a
pricing tier.
|
| StockKeepingUnit |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The SKU assigned to the related product.
|
| SubscriptionTerm |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of terms in the subscription. You can indicate a
subscription’s length using either the start and end dates, or by
using the start date and the subscription term.
|
| TotalAdjustmentAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The sum of the adjustments applied to the sales transaction item,
inclusive of quantity, prorated for the duration of the
subscription. Includes distributed price adjustment items and price
adjustment items applied directly.
|
| TotalAdjustmentDistAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The sum of the distributed price adjustment items applied to the
sales transaction item, prorated for the duration of the
subscription. Doesn’t include price adjustment items that are
applied directly.
A distributed price adjustment is
automatically created to apply a transaction-level adjustment to
the transaction items. For example, let’s say that you have an
order with two order items: one for a file storage service and
another for a video streaming service. A 10% volume discount and
a 15% manual discount are applied to the entire order. An
additional 20% discount is applied to the file storage service.
To distribute the order-level discounts, the system creates a
10% price adjustment item and a 15% price adjustment item for
each order item.
In this example, the file storage
service’s sales transaction item has the following field values:
-
TotalAdjustmentAmount the sum of
all item-level adjustments, including the 10%
price adjustment item, the 15% price adjustment item, and
the 20% price adjustment item.
-
TotalAdjustmentDistAmount the sum of
the distributed item-level adjustments, including
the 10% price adjustment item and the 15% price adjustment
item.
|
| TotalLineAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total price of the sales transaction item, before price
adjustments, inclusive of quantity, prorated for the duration of
the subscription. This calculated field is equal to
TotalPrice times
Quantity times
PricingTermCount.
|
| TotalPrice |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The price after all adjustments, inclusive of quantity, prorated
for the duration of the subscription. This calculated field is
equal to TotalAdjustmentAmount plus
TotalLineAmount.
|
j