Overview
The standard transaction line Charge Set array (_chargeSet) allows customers to synchronize the pricing charge schema with quotes to enable multiple charges for transaction line items. The pricing charge schema is defined by standard and extensible custom charge attributes.
The Synchronize Charge Array Set action allows administrators to synchronize the transaction line Charge Set array with the pricing charge schema.
The Charge Array Set contains the following read-only attributes:
| Order | Name | Variable Name | Type | Description |
|---|---|---|---|---|
|
4 |
Charge Definition |
_chargeSet_chargeDefinition |
Text |
The display label of the charge definition. |
|
5 |
Charge Definition Code |
_chargeSet_chargeDefinitionCode |
Text |
The code of the charge definition. |
|
6 |
Charge Definition Integration ID |
_chargeSet_chargeDefinitionIntegrationId |
Text |
The charge definition code in the integrated order management system. |
|
10 |
Price Type |
_chargeSet_priceType |
Menu |
The basis on which a price or charge is levied, whether one time, on a periodic basis or based on usage. |
|
20 |
Charge Type |
_chargeSet_chargeType |
Menu |
The classification of a charge associated with the price for a product or service. This attribute differentiates the purpose of charges with the same price type and price period. For example, the sale of a network device may have both a one-time purchase price (with charge type of 'Purchase Price') and a one-time installation price (with charge type of 'Installation Fee'). |
|
30 |
Price Period |
_chargeSet_pricePeriod |
Menu |
The time period, frequency, or recurrence with which the price or charge is levied. |
|
50 |
Usage UOM |
_chargeSet_usageUOM |
Menu |
The unit of measure of usage for usage charges, which may differ from the unit of measure used for the parent product. |
|
120 |
Dynamic Pricing Type |
_chargeSet_dynamicPricingType |
Text | The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced |
|
150 |
Rate Card |
_chargeSet_rateCard |
String |
Display label for the Rate Card applied in calculating this charge's price. |
|
160 |
Rate Card Variable Name |
_chargeSet_rateCardVariableName |
String |
Variable Name for the Rate Card applied in calculating this charge's price. |
|
170 |
Rate Card Structure |
_chargeSet_rateCardStructure |
Text Area |
The rate card used to calculate this charge's price. |
|
175 |
Rate Card in HTML |
_chargeSet_rateCardinHTML |
Text Area |
The HTML-formatted rate card data. |
|
200 |
Unit Price |
_chargeSet_unitPrice |
Currency |
The unit price to be paid by the customer for this charge. |
|
210 |
Calculation Information |
_chargeSet_calculationInfo |
Text Area |
A JSON array of the Price Models used in calculating this charge's price. |
|
220 |
Discount Value |
_chargeSet_discountValue |
Float |
The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge. |
|
230 |
Discount Type |
_chargeSet_discountType |
Menu |
The type of custom discount applied to this charge. Typically this may be an override price, a discount value, or a discount percentage. |
|
240 |
Discount Amount |
_chargeSet_discountAmount |
Currency |
The extended custom discount amount per period for this charge. |
|
250 |
Net Price |
_chargeSet_netPrice |
Currency |
The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced. |
|
260 |
Net Amount |
_chargeSet_netAmount |
Currency |
The extended net price or amount per period that will be paid for this charge. |
|
270 |
Tax Price |
_chargeSet_taxPrice |
Currency |
Tax to be paid for each unit of the line item. |
|
280 |
Total Price Including Tax |
_chargeSet_totalPriceInclTax |
Currency |
Total price to be paid for each unit of the line item, including taxes. |
|
290 |
Total Amount Including Tax |
_chargeSet_totalAmountInclTax |
Currency |
Total amount to be paid for the line item, including taxes. |
|
300 |
Tax Calculation Info |
_chargeSet_taxCalculationInfo |
Text Area |
A JSON array of the additional tax information like tax amount, net price excluding tax, net amount excluding tax. |
Notes:
-
You can't delete the Charge array or the standard attributes included with the Charge Set array.
-
You can't edit and reorder the standard attributes included with the Charge Set array.
-
You can't add custom attributes to the Charge Set array.
- To enable multiple charges for transaction line items, refer to Synchronize Charge Array Set.
- If the transaction line Charge Set array doesn’t exist, it will be created when the Synchronize Charge Array Set action is invoked.
- Refer to Pricing Portal > Charge Attributes for more information about pricing charge attributes.
Synchronize Charge Array Set
