Get Charges
get
/rest/v19/commerceDocumentsOraclecpqoTransaction/{id}/transactionLine/{documentNumber}/oRCL_charges
Use this endpoint to retrieve all charges/prices for the specified transaction line.
Request
Supported Media Types
- application/json
Path Parameters
-
documentNumber(required): integer
Unique document number to be used as document identifier in a process.
-
id(required): integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Query Parameters
-
excludeFieldTypes: string
Exclude specified field types.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : commerceDocumentsOraclecpqoTransactionTransactionLineORCL_charges-collection
Type:
Show Source
object-
_state:
object state
Title:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : state
Type:
objectTitle:
stateCaptures the current state of the resource collection. 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. -
defaultRowState:
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. -
focus:
object Focused Users
Title:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the collection itself. -
hasWarning:
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the collection itself. -
insertable:
boolean
Title:
InsertableBoolean value that specifies whether new rows can be inserted into the collection. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
queryable:
boolean
Title:
QueryableBoolean value that specifies whether the rows in the collection can be queried. -
sortable:
boolean
Title:
SortableBoolean value that specifies whether the rows in the collection can be sorted.
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 : 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. -
focus:
object Focused Users
Title:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier. -
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. - hidden: boolean
-
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 : Focused Users
Type:
objectTitle:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
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.
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 : Focused Users
Type:
objectTitle:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
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.
Nested Schema : Prices
Type:
objectTitle:
Show Source
Prices-
_bs_id:
integer
Title:
_bs_id_bs_id -
_document_number:
integer
Title:
_document_number_document_number -
_row_number:
integer
Title:
_row_number_row_number -
_s_oRCL_chargeDefIntegrationId:
string
Title:
Charge Definition Integration ID -
_s_oRCL_chargeType:
string
Title:
Charge Type -
_s_oRCL_contractTaxAmount:
number
Title:
Contract Tax Amount -
_s_oRCL_contractTotalAmount:
number
Title:
Contract Total Amount -
_s_oRCL_contractTotalAmountExcludingTax:
number
Title:
Contract Total Amount Excluding Tax -
_s_oRCL_customDiscountType:
string
Title:
Custom Discount Type -
_s_oRCL_dynamicPricingType:
string
Title:
Dynamic Pricing TypeFor Future Use. The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced. -
_s_oRCL_pricePeriod:
string
Title:
Price Period -
_s_oRCL_priceType:
string
Title:
Price Type -
_s_oRCL_priceUOM:
string
Title:
Price Unit of Measure -
_s_oRCL_rateCardStructure:
string
Title:
Rate Card StructureFor Future Use. The rate card used to calculate this charge's price. -
_s_oRCL_taxAmount:
number
Title:
Tax Amount -
_s_oRCL_taxPrice:
number
Title:
Tax Price -
_s_oRCL_totalAmount:
number
Title:
Total Amount Including Tax -
_s_oRCL_totalAmountExcludingTax:
number
Title:
Total Amount Excluding Tax -
_s_oRCL_TotalPrice:
number
Title:
Total Price Including Tax -
_s_oRCL_totalPriceExcludingTax:
number
Title:
Total Price Excluding Tax -
_s_oRCL_totalProratedOrderDiscount:
number
Title:
Total Prorated Order Discount -
_s_oRCL_unitProratedOrderDiscount:
number
Title:
Unit Prorated Order Discount -
_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 -
oRCL_applyTo:
string
Title:
Apply To -
oRCL_chargeName:
string
Title:
Charge Name -
oRCL_chargeSequenceNumber:
integer
Title:
Sequence Number -
oRCL_contractDiscountAmount:
number
Title:
Contract Discount Amount -
oRCL_contractListValue:
number
Title:
Contract List Value -
oRCL_contractNetValue:
number
Title:
Contract Net Value -
oRCL_customDiscountAmount:
number
Title:
Custom Discount Amount -
oRCL_discountAmount:
number
Title:
Discount Amount -
oRCL_listAmount:
number
Title:
List Amount -
oRCL_listPrice:
number
Title:
List Price -
oRCL_netAmount:
number
Title:
Net Amount -
oRCL_netPrice:
number
Title:
Net Price -
oRCL_primaryCharge:
boolean
Title:
Primary Charge
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.