Skip to content

Item

API Name: Item__c

The item object represents a contracted, chargeable product included in a subscription.

Label API Name Type Description
Order No. Name Text
Active Active__c Checkbox Controls whether or not this item is included in the invoice run.
Additional Description AdditionalDescription__c LongTextArea(32768) Specifies an additional description for the item.
Additional Title AdditionalTitle__c TextArea Specifies an additional title for the item.
Aggregate Indiv. Priced Transactions AggregateIndividualPriced__c Checkbox Controls whether or not to aggregate transactions with individual prices into one transaction.
Billing Period BillingPeriod__c Number(2, 0) Specifies the cycle (time in months) after which the item is included in the invoice run.
Billing Type BillingType__c Picklist Determines the method for calculating quantities.
Billing Unit BillingUnit__c Picklist Defines the time unit for the billing period (Day or Month), which is used for the price calculation of the billing period.
Charge Model ChargeModel__c Picklist Allows to define pricing scenarios that consider a specific business logic (Mark Up/Mark Down).
Commission Commission__c Percent(3, 2) Specifies a percentage commission that calculates the line item total based on the unit price and the defined percentage.
Contract Value Correction ContractValueCorrection__c Currency(16, 2) Allows to specify a corrective value to be deducted from the contract value because it has already been invoiced.
Contract Value Invoiced ContractValueInvoiced__c Currency(16, 2) Shows the actually invoiced contract value, which is updated each time an invoice or an invoice line item is changed or deleted.
Contract Value Remaining ContractValueRemaining__c Currency(16, 2) Shows the remaining contract value, which is calculated based on the other three values (Remaining Contract Value = Contract Value - Contract Value Correction - Invoiced Contract Value).
Contract Value ContractValue__c Currency(16, 2) Shows the overall value of the item for the whole subscription period.
Decimal Places for Quantity DecimalPlacesForQuantity__c Number(2, 0) The number of decimal places for the quantity as displayed on the invoice.
Decimal Places for Unit Price DecimalPlacesForUnitPrice__c Number(2, 0) The number of decimal places for the unit price as displayed on the invoice.
Description Description__c LongTextArea(32768) A long description for this item, which can be printed on the invoice line item.
Discount Discount__c Percent(3, 2) Specifies a percentage discount rate that is applied to the item price.
Display Subtotal After This Item DisplaySubtotalAfter__c Checkbox Defines whether a subtotal is displayed after this item.
End Date EndDate__c Date The date until which this item is active.
Expected Revenue ExpectedRevenue__c Currency(16, 2) The monthly expected revenue. This is only valid for transactional items and will be analyzed for MRR reporting.
Include In Monthly Minimum GlobalMonthlyMinimum__c Checkbox Controls whether this item is included in the monthly minimum fee.
Ignore Criterion For Price Tier Quantity IgnoreCriterionForPriceTierQuantity__c Checkbox If checked, the price tier quantity is determined independently of the item criterion.
Ignore Item Criterion IgnoreCriterion__c Checkbox If checked, the aggregation criterion of transactions (or other objects) is ignored, and the invoice line items are not grouped.
Invoice Line Item Type InvoiceLineItemType__c Picklist Specifies the type of the invoice line item. If empty, defaults to product.
Next Service Period Start NextInvoice__c Date Holds the next billing date for this item.
Order By OrderBy__c Text(255) The API name of an invoice line item field by which the line items are to be ordered.
Previous End Date PreviousEndDate__c Date The previously recorded end date for this item. This is used to detect and record subscription metric changes. DO NOT EDIT!
Previous End Metric PreviousEndMetric__c Currency(16, 2) Holds the amount of the previous end amount. This is used to detect and record subscription metric changes. DO NOT EDIT!
Previous Start Metric PreviousStartMetric__c Currency(16, 2) Holds the amount of the previous start amount. This is used to detect and record subscription metric changes. DO NOT EDIT!
Price Type PriceType__c Picklist Specifies the price calculation method of this item (Default or Flat), is ignored when using price tiers.
Price Price__c Currency(13, 5) Specifies the item price, is ignored when using price tiers.
Product Group ProductGroup__c Text(255) Allows for specifying the product group of this item.
Quantity Quantity__c Number(13, 5) Specifies the quantity used to bill recurring and one-time items. Does not affect transactional items.
Reverse Reverse__c Checkbox If checked, the display order of the invoice line items created from this item is reversed.
Sequence Sequence__c Number(18, 0) Determines the position of this item in the item table.
Source Child Id SourceChildId__c Text(18) Holds the id of the source child. The field is set during subscription building.
Source Parent Id SourceParentId__c Text(18) Holds the id of the source parent. The field is set during subscription building. The field is used to channel subscription updates in case of items with duplicate order numbers.
Start Date StartDate__c Date The start date from which this item is active.
Subscription Subscription__c Lookup(Subscription__c) The subscription to which this item relates.
Sync With SyncWith__c Picklist Specifies a specific date with which the billing period of a recurring item is to be syncronized.
Title Title__c TextArea Specifies the title or name of a product.
Transaction Aggregation Fields TransactionAggregationFields__c LongTextArea(32768) Defines additional fields of transactions that are to be aggregated for this item. Format: {"FIELDNAME1":"FUNCTION","FIELDNAME2":"FUNCTION"}. Valid functions include SUM, MIN, MAX, LAST.
Transaction Commission Tier Price Field TransactionCommissionTierPriceField__c Text(255) Defines a source field for the commission tier price that is to be used during the transaction building.
Transaction Price Field TransactionPriceField__c Text(255) Defines a source field for the price that is to be used during the transaction building.
Transaction Price Tier Quantity Field TransactionPriceTierQuantityField__c Text(255) Defines a source field for the price tier quantity that is to be used during the transaction building.
Transaction Quantity Field TransactionQuantityField__c Text(255) Defines a source field for the quantity that is to be used during the transaction building.
Transaction Type TransactionType__c Picklist Specifies the type of transactions that are to be billed with this item.
Unit Unit__c Picklist Specifies the unit that is associated with this item.