Get Transaction Line Charge
get
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_chargeSet/{_row_number}
Use this endpoint to retrieve the specified transaction line charge.
Request
Supported Media Types
- application/json
Path Parameters
-
MainDocVarName(required): string
The variable name of the main document, note the first letter must be capitalized.
-
ProcessVarName(required): string
The variable name of the commerce process, note the first letter must be capitalized.
-
_row_number(required): integer
Unique row number to be used as row identifier in an array set.
-
docNumber(required): integer
Unique number to be used as the sub-document identifier.
-
id(required): integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
-
subDocVarName(required): string
The variable name for the sub-document.
Query Parameters
-
excludeFieldTypes: string
Exclude specified field types.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Charge Set
Type:
objectTitle:
Show Source
Charge Set-
_bs_id:
integer
Title:
_bs_id_bs_id -
_chargeSet_calculationInfo:
string
Title:
Calculation InformationA JSON array of the Price Models used in calculating this charge's price. -
_chargeSet_chargeDefinition:
string
Title:
Charge DefinitionThe display label of the charge definition. -
_chargeSet_chargeDefinitionCode:
string
Title:
Charge Definition CodeThe code of the charge definition. -
_chargeSet_chargeDefIntegrationId:
string
Title:
Charge Definition Integration IDThe charge definition code in the integrated order management system. -
_chargeSet_chargeType:
object Charge Type
Title:
Charge Type -
_chargeSet_discountAmount:
object Discount Amount
Title:
Discount AmountThe extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity. -
_chargeSet_discountType:
object Discount Type
Title:
Discount Type -
_chargeSet_discountValue:
number
Title:
Discount ValueThe 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. -
_chargeSet_dynamicPricingType:
string
Title:
Dynamic Pricing TypeThe type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced. -
_chargeSet_netAmount:
object Net Amount
Title:
Net AmountThe extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity. -
_chargeSet_netPrice:
object Net Price
Title:
Net PriceThe unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced. -
_chargeSet_pricePeriod:
object Price Period
Title:
Price Period -
_chargeSet_priceType:
object Price Type
Title:
Price Type -
_chargeSet_rateCardInHTML:
string
Title:
Rate Card In HTMLThe HTML-formatted rate card data -
_chargeSet_rateCardName:
string
Title:
Rate CardDisplay label for the Rate Card applied in calculating this charge's price. -
_chargeSet_rateCardStructure:
string
Title:
Rate Card StructureThe rate card used to calculate this charge's price. -
_chargeSet_rateCardVariableName:
string
Title:
Rate Card Variable NameVariable Name for the Rate Card applied in calculating this charge's price. -
_chargeSet_unitPrice:
object Unit Price
Title:
Unit PriceThe unit price to be paid by the customer for this charge. -
_chargeSet_usageUOM:
object Usage UOM
Title:
Usage UOM -
_document_number:
integer
Title:
_document_number_document_number -
_row_number:
integer
Title:
_row_number_row_number -
_sequence_number:
integer
Title:
_sequence_number_sequence_number -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_transaction_currency_pref:
object _transaction_currency_pref
Title:
_transaction_currency_pref
Nested Schema : Charge Type
Type:
objectTitle:
Show Source
Charge Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Discount Amount
Type:
objectTitle:
Discount AmountThe extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Discount Type
Type:
objectTitle:
Show Source
Discount Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Net Amount
Type:
objectTitle:
Net AmountThe extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Net Price
Type:
objectTitle:
Net PriceThe unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Price Period
Type:
objectTitle:
Show Source
Price Period-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Unit Price
Type:
objectTitle:
Unit PriceThe unit price to be paid by the customer for this charge.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Usage UOM
Type:
objectTitle:
Show Source
Usage UOM-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : state
Type:
objectTitle:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
-
actions:
object Actions
Title:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action. -
attributes:
object Attributes
Title:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute. -
deletable:
boolean
Title:
DeletableBoolean value that specifies whether the row can be deleted. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the row itself. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
updatable:
boolean
Title:
UpdatableBoolean value that specifies whether the row can be updated.
Nested Schema : _transaction_currency_pref
Type:
objectTitle:
Show Source
_transaction_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Nested Schema : Actions
Type:
objectTitle:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type:
objectTitle:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.