Calculate Transaction Line Item Price
post
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/actions/_calculate_price_action
Use this endpoint to apply pricing changes for updates to transaction line price attributes.
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.
-
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.
Root Schema : TransactionLine-CalculatePriceRequest
Type:
Show Source
object
-
cacheInstanceId:
string
Title:
Cache Instance Id
The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db. -
criteria:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
delta:
boolean
Title:
Delta
The boolean parameter to request a delta response for data as well as state in the context of current criteria. -
documents:
object Transaction Line
Title:
Transaction Line
-
revisionId:
string
Title:
Revision Id
The string parameter that contains the revision information.
Nested Schema : Query Definition
Type:
object
Title:
Query Definition
Captures the query definition for the current resource request.
Show Source
-
actions:
array actions
Array of actions names, whose state is requested in the state object response.
-
childDefs:
array childDefs
-
expand:
array expand
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
-
expandedDomains:
array expandedDomains
Array of field names, whose expanded domains are requested in the state object response.
-
fields:
array fields
Array of field names that you wanted returned in a request.
-
state:
boolean
Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
Nested Schema : Transaction Line
Type:
object
Title:
Show Source
Transaction Line
-
_availableRatePlans:
object Available Rate Plans
Title:
Available Rate Plans
-
_availableRatePlanSet:
object TransactionLine_availableRatePlanSet-collection
-
_availableRatePlanSetControl:
integer
Title:
Available Rate Plan Set Control
-
_bs_id:
integer
Title:
_bs_id
-
_chargeSet:
object TransactionLine_chargeSet-collection
-
_chargeSetControl:
integer
Title:
Charge Set Control
-
_config_attr_info:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_attr_text:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_attr_values:
string
Title:
Config Attribute Values
Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported. -
_config_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_extra_info:
string
Title:
Config Extra Info
Configuration Extra Information. -
_configuration_id:
string
Title:
Configuration ID
Configuration id for integrations. -
_date_added:
string
Title:
_date_added
-
_date_modified:
string
Title:
_date_modified
-
_delta_price:
object Delta Price
Title:
Delta Price
Delta Price -
_document_number:
integer
Title:
_document_number
-
_document_var_name:
string
Title:
_document_var_name
-
_group_sequence_number:
string
Title:
Group Sequence Number
Group sequence number for the subdocument. -
_id:
integer
Title:
_id
-
_is_bom_price:
boolean
Title:
Is BOM Price
Used to identify if the line item has BOM price. Applicable for a BOM item only -
_is_coverage:
boolean
Title:
Is Coverage Product
Indicates whether the product is of coverage type -
_is_line_item_mandatory:
boolean
Title:
Is Line Item Mandatory
Used to identify if the line item is mandatory. -
_is_part_pricing_rule_price:
boolean
Title:
Is Price from Pricing Rule
Used to identify if a line item has a part pricing rule set by a rule -
_is_recommended_price:
boolean
Title:
Is Price Recommended
Used to identify if the line item has recommended price set by a rule. -
_last_modified_date:
string
Title:
Last Modified Date
Used to Store the last modified date of the sub-document. -
_line_bom_attributes:
string
Title:
Line Item BOM Attributes
BOM attributes, stored as a JSON string. -
_line_bom_condition_index:
string
Title:
Line BOM Condition Index
The condition index of the BOM item -
_line_bom_display_name:
string
Title:
Line BOM Display Name
The display name of the BOM item -
_line_bom_effective_date:
string
Title:
Line BOM Effective Date
System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings. -
_line_bom_id:
string
Title:
Line Item BOM ID
The BOM item instance id. -
_line_bom_item_quantity:
integer
Title:
Line BOM Item Quantity
The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity. -
_line_bom_level:
integer
Title:
Line BOM Level
The BOM item depth (level) in the quote. -
_line_bom_model_path:
string
Title:
Line BOM Model Path
The model path of the BOM item; only applicable to the model line -
_line_bom_name:
string
Title:
Line BOM Name
The name of the BOM item -
_line_bom_parent_id:
string
Title:
Parent Line Item BOM ID
The parent BOM item instance id. -
_line_bom_part_number:
string
Title:
Line BOM Part Number
The part number of the BOM item. Only applicable to the model line. -
_line_bom_sequence_index:
string
Title:
Line BOM Sequence Index
The sequence index of the BOM item -
_line_bom_variable_name:
string
Title:
Line BOM Variable Name
The variable name of the BOM item -
_line_display_name:
string
Title:
Line Display Name
Display name attribute for line items. -
_line_item_comment:
string
Title:
Line Item Comments
Stores the comments for the line item. -
_line_item_spare_rule_var_name:
string
Title:
Line Item Identifier
Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier -
_line_item_type:
string
Title:
Line Item Type
Type attribute for line items. -
_model_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_model_base_price:
object Model Base Price
Title:
Model Base Price
Base price of the model -
_model_bom:
string
Title:
Model BOM
Model BOM Link -
_model_id:
string
Title:
Model ID
Id of the model -
_model_is_valid:
boolean
Title:
Is Model Valid
Check if model is configured or unconfigured -
_model_name:
string
Title:
Model Name
Name of the model -
_model_partner_entity_id:
string
Title:
Model Partner Entity Id
Partner entity id for the model -
_model_partner_organization_id:
string
Title:
Model Partner Organization Id
partner organization id for the model -
_model_product_line_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_model_product_line_id:
string
Title:
Model Product Line ID
Id of the Product Line to which the model belongs -
_model_product_line_name:
string
Title:
Model Product Line Name
Product Line to which the model belongs -
_model_product_line_var_name:
string
Title:
Model Product Line Variable Name
Variable name of the product line that the model belongs to. -
_model_sales_product_type:
string
Title:
Model Sales Product Type
ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_model_segment_id:
string
Title:
Model Segment ID
Id of the Segment to which the model belongs -
_model_segment_name:
string
Title:
Model Segment Name
Segment to which the model belongs -
_model_segment_var_name:
string
Title:
Model Segment Variable Name
Segment to which the model belongs -
_model_supplier_company_id:
string
Title:
Model Supplier Company ID
Model supplier company id -
_model_supplier_company_name:
string
Title:
Model Supplier Company Name
Model supplier company name -
_model_variable_name:
string
Title:
Model Variable Name
Variable name of the model -
_original_document_number:
string
Title:
Original Document Number
Used to identify the document number from which the line item is copied. -
_parent_doc_number:
string
Title:
Parent Document Number
Used to identify the parent document number, if any, for this subdocument. -
_parent_line_item:
string
Title:
Parent Line Item
Used to identify the name of the parent line item, if any, for this subdocument. -
_part_base_price:
object Part Base Price
Title:
Part Base Price
Price of the part -
_part_company_associations:
string
Title:
Company Associations
Company Associations -
_part_css_enabled:
string
Title:
Enable Customer Self-Service
Customer Self-service enabled flag -
_part_default_periodicity:
string
Title:
Part Price Period
Default Price Periodicity -
_part_default_periods:
string
Title:
Number of Price Periods
Default number of price periods -
_part_default_price_type:
string
Title:
Part Price Type
Default Price Type -
_part_default_uom:
string
Title:
Default UOM Code
Default unit of measure -
_part_desc:
string
Title:
Part Description
Description of the part -
_part_direct_buy:
string
Title:
Direct Buy
Direct Buy -
_part_display_number:
string
Title:
Part Display Number
Part Display Number -
_part_drawing_position:
string
Title:
Drawing Position
Drawing Position -
_part_extended_desc_1:
string
Title:
Part Extended Description 1
Extended description of the part -
_part_extended_desc_2:
string
Title:
Part Extended Description 2
Extended description of the part -
_part_external_key1:
string
Title:
External Key 1
External system's key -
_part_external_key2:
string
Title:
External Key 2
External system's key -
_part_id:
string
Title:
Part ID
Id of the part -
_part_lead_time:
string
Title:
Part Lead Time
Lead time -
_part_number:
string
Title:
Part Number
Part Number -
_part_sale_enabled:
string
Title:
Eligible to Sell
Eligible to sell or order -
_part_sales_product_type:
string
Title:
Sales Product Type
ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_part_serv_req_enabled:
string
Title:
Eligible for Service
Eligible for service -
_part_supplier_company_id:
string
Title:
Part Supplier Company ID
Id of the part supplier company -
_part_supplier_company_name:
string
Title:
Part Supplier Company Name
Name of the part supplier company -
_part_units:
string
Title:
Part Units
Units of the part -
_partner_entity_id:
string
Title:
Partner Entity Id
Partner Entity Id -
_partner_organization_id:
string
Title:
Partner Organization Id
Partner Organization Id -
_pp_id:
integer
Title:
_pp_id
-
_pp_name:
string
Title:
_pp_name
-
_price_applied_agreement_integrationId:
string
Title:
Applied Agreement Integration ID
Applied Agreement Integration Id -
_price_applied_agreement_name:
string
Title:
Applied Agreement Name
Applied Agreement Name -
_price_applied_agreement_number:
string
Title:
Applied Agreement Number
Applied Agreement Number -
_price_applied_ratePlan:
string
Title:
Applied Rate Plan
Applied Rate Plan -
_price_applied_ratePlan_integrationId:
string
Title:
Applied Rate Plan Integration ID
Applied Rate Plan Integration Id -
_price_applied_ratePlan_number:
string
Title:
Applied Rate Plan Number
Applied Rate Plan Number -
_price_book_var_name:
string
Title:
Price Book Variable Name
Variable Name of the Price Book used to get the price for this line item -
_price_calculation_info:
string
Title:
Calculation Information
JSON array of aggregated calculation information returned from advanced pricing profiles -
_price_component_prices:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_price_configurable_price:
object Configurable Price
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium) -
_price_item_price_each:
object Item Price
Title:
Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices. -
_price_list_price_each:
object List Price
Title:
List Price
Will usually be the same value as the Item Price, unless a recommended item price applies. -
_price_period:
string
Title:
Pricing Engine Price Period
Period for which the price will be applicable. -
_price_quantity:
integer
Title:
Quantity
Quantity -
_price_type:
string
Title:
Pricing Engine Price Type
Type of price (For example: One-time, Periodic - monthly, quarterly etc) -
_price_unit_price_each:
object Unit Price
Title:
Unit Price
Will usually be the same value as the List Price, unless a contract price applies. -
_pricing_rule_price_each:
object Pricing Rule Price
Title:
Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models) -
_prior_price:
object Prior Price
Title:
Prior Price
Prior Price -
_reconfiguration_date:
string
Title:
Reconfiguration Date
Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model. -
_revenueCategory_l:
object Revenue Category
Title:
Revenue Category
-
_revenueId_l:
string
Title:
Revenue ID
The ID of the Revenue Line Item in the associated opportunity. -
_rollup_delta_price:
object Rollup Delta Price
Title:
Rollup Delta Price
Rollup Delta Price -
_s_coverageLineNumber:
string
Title:
Coverage Line Number
Source line number of the coverage line for OM Integration. -
_s_coverageOrderNumber:
string
Title:
Coverage Order Number
Source order number of the coverage line for OM Integration. -
_s_freezeNegotiationFlag_l:
boolean
Title:
Freeze Negotiation Flag
Flag indicating whether price negotiation is permitted. -
_s_partID_l:
string
Title:
Part ID
Part number from the Items table. -
_sequence_number:
integer
Title:
Sequence Number
Sequence number for the subdocument. -
_state:
object state
Title:
state
Captures 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. -
_step_var_name:
string
Title:
_step_var_name
-
_transaction_currency_pref:
string
Title:
_transaction_currency_pref
-
_transactionLine_id:
string
Title:
Transaction Line ID
Unique identifier for this subdocument. -
annualCost_l:
object Annual Cost
Title:
Annual Cost
The extended cost for recurring pricing on this transaction line. -
annualDiscount_l:
object Annual Discount
Title:
Annual Discount
The annual discount on the recurring charges on this line. -
annualListValue_l:
object Annual Value (List)
Title:
Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods. -
annualMargin_l:
object Annual Margin
Title:
Annual Margin
The extended margin for recurring pricing on this transaction line. -
annualValue_l:
object Annual Value (Net)
Title:
Annual Value (Net)
The annual contract value of the recurring charges on this line. -
associatedLineId_l:
string
Title:
Associated Line Id
Document number to be associated with the subscription line. -
associatedOrderId_l:
string
Title:
Associated Order Id
Source order Id associated with the subscription line -
cancelReason_l:
object Cancel Reason
Title:
Cancel Reason
-
changeCode_l:
object Change Code
Title:
Change Code
-
changeReason_l:
object Change Reason
Title:
Change Reason
-
contractCost_l:
object Contract Cost
Title:
Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs. -
contractDiscount_l:
object Contract Discount
Title:
Contract Discount
The total discount of this line including all one-time and recurring charges. -
contractedPeriods_l:
integer
Title:
Contracted Periods
Number of periods the customer has contracted to receive the item. -
contractedPeriodsRollup_l:
integer
Title:
Contracted Periods (Rollup)
Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values. -
contractEndDate_l:
string
Title:
Contract End Date
Date that the customer stops to receive the service. -
contractListValue_l:
object Contract Value (List)
Title:
Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges. -
contractListValueRollup_l:
object Contract Value (List Rollup)
Title:
Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines. -
contractMargin_l:
object Contract Margin
Title:
Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values. -
contractStartDate_l:
string
Title:
Contract Start Date
Date that the customer starts to receive the service. -
contractValue_l:
object Contract Value (Net Summable)
Title:
Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges. -
contractValueRollup_l:
object Contract Value (Net Rollup)
Title:
Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines. -
costAmount_l:
object Cost Amount
Title:
Cost Amount
The total cost of this line. -
createdBy_l:
string
Title:
Created By
The person that created the transaction line. -
createdDate_l:
string
Title:
Created Date
The date when the transaction line was created. -
customDiscountAmount_l:
object Custom Discount Amount
Title:
Custom Discount Amount
The amount by which to adjust the list price because of a custom discount. -
customDiscountType_l:
object Discount Type
Title:
Discount Type
-
customDiscountValue_l:
number
Title:
Discount
Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage. -
discountAmount_l:
object Amount (Discount)
Title:
Amount (Discount)
The discount amount for this line. -
discountPercent_l:
number
Title:
Discount %
The percentage of the Contract Value (List) that is discounted off of the transaction line. -
discountPercentRollup_l:
number
Title:
Discount Percent (Rollup)
The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values. -
documentNumber_l:
string
Title:
Document Number
Document number of the line. -
fulfillmentLineId_l:
string
Title:
Fulfillment Line Id
Value that uniquely identifies the fulfillment line. -
fulfillmentOrganizationCode_l:
string
Title:
Fulfillment Organization Code
Abbreviation that identifies the organization that ships the shipment. -
fulfillmentStatus_l:
object Fulfillment Status
Title:
Fulfillment Status
-
includedInBasePrice:
boolean
Title:
Included In Base Price
Used to identify if the line item is included in the base price. Applicable for a BOM item only. -
itemInstanceId_l:
string
Title:
Instance ID
The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created. -
itemInstanceName_l:
string
Title:
Instance Name
The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance. -
lastUpdatedBy_l:
string
Title:
Last Updated By
The person that last updated this transaction line. -
lastUpdatedDate_l:
string
Title:
Last Updated
The date and time the transaction line was last updated. -
lineNumber_l:
integer
Title:
Line Number
Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents. -
lineType_l:
object Line Type
Title:
Line Type
-
listAmount_l:
object Amount (List)
Title:
Amount (List)
The extended list amount for this line. -
listPrice_l:
object Price (List)
Title:
Price (List)
The list price of the item. -
listPriceRollup_l:
object List Price (Rollup)
Title:
List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values. -
marginAmount_l:
object Margin Amount
Title:
Margin Amount
The margin for all quoted units of this transaction line. -
marginPercent_l:
number
Title:
Margin %
The percentage of the List price for which this transaction line's margin accounts. -
monthlyRecurRevRollup_l:
object MRR (Rollup)
Title:
MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines. -
monthlyRecurRevSummable_l:
object MRR (Summable)
Title:
MRR (Summable)
Monthly recurring revenues net of all discounts for this line. -
monthlyUsageRevRollup_l:
object MUR (Rollup)
Title:
MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines. -
monthlyUsageRevSummable_l:
object MUR (Summable)
Title:
MUR (Summable)
Monthly usage revenues net of all discounts for this line. -
netAmount_l:
object Amount (Net)
Title:
Amount (Net)
The extended list amount minus any discounts for this line. -
netAmountRollup_l:
object Net Amount (Rollup)
Title:
Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values. -
netPrice_l:
object Price (Net)
Title:
Price (Net)
The price paid by the customer for the item. -
netPriceRollup_l:
object Net Price (Rollup)
Title:
Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values. -
nonRecurRevRollup_l:
object Non-Recurring Revenue (Rollup)
Title:
Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines. -
nonRecurRevSummable_l:
object Non-Recurring Revenue (Summable)
Title:
Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line. -
oRCL_ABO_ActionCode_l:
object Action Code
Title:
Action Code
-
oRCL_ABO_ComponentAttributes_l:
string
Title:
Component Attributes
A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed. -
oRCL_ERP_OrderNumber_l:
string
Title:
Order Number
The order number assigned by the external Order Management and ERP system. -
oRCL_SFA_InventoryItemID_l:
string
Title:
Inventory Item ID
The inventory item id of the sales product in SFA. -
oRCL_SFA_InventoryOrgID_l:
string
Title:
Partner Orgnanization ID
The inventory organization in SFA used for sales products. -
oRCL_SFA_Status_l:
string
Title:
Opportunity Win/Loss Status (Line)
The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value. -
orderDate_l:
string
Title:
Order Date
The date and time the order was placed for fulfillment. -
ownerResourceId_l:
string
Title:
Owner Resource ID
The owner of the associated Opportunity Revenue Line. -
parentAssetKey_l:
string
Title:
Parent Asset Key
The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines. -
parentDocNumber_l:
string
Title:
Parent Doc Number
Document number of the parent line item. -
paymentTerms_l:
object Payment Terms
Title:
Payment Terms
-
pricePeriod_l:
object Period
Title:
Period
-
priceRecurFrequency_l:
object Price Recurrence Frequency
Title:
Price Recurrence Frequency
-
priceRecurFrequencyRollup_l:
object Price Recurrence Frequency (Rollup)
Title:
Price Recurrence Frequency (Rollup)
-
priceScore_l:
integer
Title:
Price Score
The calculated price score for this transaction line, based on the line item's List and Net pricing. -
priceType_l:
object Price Type
Title:
Price Type
-
priceTypeRollup_l:
object Price Type (Rollup)
Title:
Price Type (Rollup)
-
priceWithinPolicy_l:
boolean
Title:
Price Within Policy
Flag which indicates if line price is within requesting user's defined pricing limits -
recurRevRollup_l:
object Recurring Revenue (Rollup)
Title:
Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines. -
recurringRevSummable_l:
object Recurring Revenue (Summable)
Title:
Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line. -
renewDate_l:
string
Title:
Renew Date
Renewal date of a subscription service. -
requestDate_l:
string
Title:
Request Date
The date on which the user requests that fulfillment occur for this transaction line. -
requestedUnitOfMeasure_l:
object Unit of Measure
Title:
Unit of Measure
-
requestShipDate_l:
string
Title:
Request Ship Date
The requested ship date for the order line. -
resumeDate_l:
string
Title:
Resume Date
Resuming date of a subscription service -
rollupFlag_l:
boolean
Title:
Rollup Flag
Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price. -
rootAssetKey_l:
string
Title:
RootAssetKey
-
rootLine_l:
object Root Line
Title:
Root Line
-
salesChannel_l:
object Sales Channel
Title:
Sales Channel
-
status_l:
object Status
Title:
Status
-
subscriptionId_l:
string
Title:
Subscription Id
The unique identifier for the subscription. Used only for subscription billing-related transactions. -
subscriptionLineId_l:
string
Title:
Subscription Line Id
The unique identifier for the subscription line. Used only for subscription billing-related transactions. -
suspendDate_l:
string
Title:
Suspend Date
Suspension date of a subscription service -
transactionID_l:
string
Title:
Transaction Internal ID
The parent transaction's internal ID. -
unitCost_l:
object Unit Cost
Title:
Unit Cost
The unit cost of the item. -
unitMargin_l:
object Margin
Title:
Margin
The margin for a single unit of this transaction line. -
usageRevRollup_l:
object Usage Revenue (Rollup)
Title:
Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines. -
usageRevSummable_l:
object Usage Revenue (Summable)
Title:
Usage Revenue (Summable)
Usage revenue net of all discounts for this line. -
winLossStatus_l:
object Win/Loss Status
Title:
Win/Loss Status
Nested Schema : actions
Type:
array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type:
Show Source
array
-
Array of:
object Child query criteria.
Title:
Child query criteria.
Captures the query criteria for the child resource.
Nested Schema : expand
Type:
array
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
Show Source
Nested Schema : expandedDomains
Type:
array
Array of field names, whose expanded domains are requested in the state object response.
Show Source
Nested Schema : fields
Type:
array
Array of field names that you wanted returned in a request.
Show Source
Nested Schema : Child query criteria.
Type:
object
Title:
Child query criteria.
Captures the query criteria for the child resource.
Show Source
-
name:
string
Rest alias name of the child resource this query belongs to.
-
queryDef:
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
recursive:
boolean
Boolean value that specifies whether this query is a recursive expand on the current child resource query.
Nested Schema : Available Rate Plans
Type:
object
Title:
Show Source
Available Rate Plans
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : TransactionLine_availableRatePlanSet-collection
Type:
Show Source
object
-
_state:
object state
Title:
state
Captures 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 : TransactionLine_chargeSet-collection
Type:
Show Source
object
-
_state:
object state
Title:
state
Captures 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 : Commerce Composite Attribute
Type:
object
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes.
Show Source
-
value:
object Value
Title:
Value
Composite attribute value
Nested Schema : Delta Price
Type:
object
Title:
Delta Price
Delta Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Model Base Price
Type:
object
Title:
Model Base Price
Base price of the model
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Part Base Price
Type:
object
Title:
Part Base Price
Price of the part
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Configurable Price
Type:
object
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium)
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Item Price
Type:
object
Title:
Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : List Price
Type:
object
Title:
List Price
Will usually be the same value as the Item Price, unless a recommended item price applies.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Unit Price
Type:
object
Title:
Unit Price
Will usually be the same value as the List Price, unless a contract price applies.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Pricing Rule Price
Type:
object
Title:
Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models)
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Prior Price
Type:
object
Title:
Prior Price
Prior Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Revenue Category
Type:
object
Title:
Show Source
Revenue Category
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Rollup Delta Price
Type:
object
Title:
Rollup Delta Price
Rollup Delta Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : state
Type:
object
Title:
state
Captures 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:
Actions
Captures 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:
Attributes
Captures 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:
Deletable
Boolean value that specifies whether the row can be deleted. -
hasError:
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the row itself. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
updatable:
boolean
Title:
Updatable
Boolean value that specifies whether the row can be updated.
Nested Schema : Annual Cost
Type:
object
Title:
Annual Cost
The extended cost for recurring pricing on this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Discount
Type:
object
Title:
Annual Discount
The annual discount on the recurring charges on this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Value (List)
Type:
object
Title:
Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Margin
Type:
object
Title:
Annual Margin
The extended margin for recurring pricing on this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Value (Net)
Type:
object
Title:
Annual Value (Net)
The annual contract value of the recurring charges on this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Cancel Reason
Type:
object
Title:
Show Source
Cancel Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Change Code
Type:
object
Title:
Show Source
Change Code
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Change Reason
Type:
object
Title:
Show Source
Change Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Contract Cost
Type:
object
Title:
Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Discount
Type:
object
Title:
Contract Discount
The total discount of this line including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (List)
Type:
object
Title:
Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (List Rollup)
Type:
object
Title:
Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Margin
Type:
object
Title:
Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (Net Summable)
Type:
object
Title:
Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (Net Rollup)
Type:
object
Title:
Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Cost Amount
Type:
object
Title:
Cost Amount
The total cost of this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Custom Discount Amount
Type:
object
Title:
Custom Discount Amount
The amount by which to adjust the list price because of a custom discount.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Discount Type
Type:
object
Title:
Show Source
Discount Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Amount (Discount)
Type:
object
Title:
Amount (Discount)
The discount amount for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Fulfillment Status
Type:
object
Title:
Show Source
Fulfillment Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Line Type
Type:
object
Title:
Show Source
Line Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Amount (List)
Type:
object
Title:
Amount (List)
The extended list amount for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Price (List)
Type:
object
Title:
Price (List)
The list price of the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : List Price (Rollup)
Type:
object
Title:
List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Margin Amount
Type:
object
Title:
Margin Amount
The margin for all quoted units of this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MRR (Rollup)
Type:
object
Title:
MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MRR (Summable)
Type:
object
Title:
MRR (Summable)
Monthly recurring revenues net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MUR (Rollup)
Type:
object
Title:
MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MUR (Summable)
Type:
object
Title:
MUR (Summable)
Monthly usage revenues net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Amount (Net)
Type:
object
Title:
Amount (Net)
The extended list amount minus any discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Net Amount (Rollup)
Type:
object
Title:
Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Price (Net)
Type:
object
Title:
Price (Net)
The price paid by the customer for the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Net Price (Rollup)
Type:
object
Title:
Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Non-Recurring Revenue (Rollup)
Type:
object
Title:
Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Non-Recurring Revenue (Summable)
Type:
object
Title:
Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Action Code
Type:
object
Title:
Show Source
Action Code
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Payment Terms
Type:
object
Title:
Show Source
Payment Terms
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Period
Type:
object
Title:
Show Source
Period
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency
Type:
object
Title:
Show Source
Price Recurrence Frequency
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency (Rollup)
Type:
object
Title:
Show Source
Price Recurrence Frequency (Rollup)
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type (Rollup)
Type:
object
Title:
Show Source
Price Type (Rollup)
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Recurring Revenue (Rollup)
Type:
object
Title:
Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Recurring Revenue (Summable)
Type:
object
Title:
Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Unit of Measure
Type:
object
Title:
Show Source
Unit of Measure
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Root Line
Type:
object
Title:
Show Source
Root Line
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sales Channel
Type:
object
Title:
Show Source
Sales Channel
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Status
Type:
object
Title:
Show Source
Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Unit Cost
Type:
object
Title:
Unit Cost
The unit cost of the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Margin
Type:
object
Title:
Margin
The margin for a single unit of this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Usage Revenue (Rollup)
Type:
object
Title:
Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Usage Revenue (Summable)
Type:
object
Title:
Usage Revenue (Summable)
Usage revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Win/Loss Status
Type:
object
Title:
Show Source
Win/Loss Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : state
Type:
object
Title:
state
Captures 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:
Actions
Captures 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:
state
Captures 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 Users
Details 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 Error
Boolean value that specifies whether any error that occurred has been assigned to the collection itself. -
hasWarning:
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the collection itself. -
insertable:
boolean
Title:
Insertable
Boolean value that specifies whether new rows can be inserted into the collection. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
queryable:
boolean
Title:
Queryable
Boolean value that specifies whether the rows in the collection can be queried. -
sortable:
boolean
Title:
Sortable
Boolean value that specifies whether the rows in the collection can be sorted.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Available Rate Plan Set
Title:
Available Rate Plan Set
Nested Schema : Actions
Type:
object
Title:
Actions
Captures 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 : Focused Users
Type:
object
Title:
Focused Users
Details 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:
array
Title:
Messages
Array of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Available Rate Plan Set
Type:
object
Title:
Show Source
Available Rate Plan Set
-
_availableRatePlanSet_rate_plan_integration_id:
string
Title:
Available Rate Plan Integration Id
Rate Plan Integration ID -
_availableRatePlanSet_rate_plan_name:
string
Title:
Available Rate Plan Name
Rate plan name -
_availableRatePlanSet_rate_plan_number:
string
Title:
Available Rate Plan Number
Rate Plan Number -
_bs_id:
integer
Title:
_bs_id
_bs_id -
_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:
state
Captures 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 : _transaction_currency_pref
Type:
object
Title:
Show Source
_transaction_currency_pref
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency. -
id:
integer
Title:
Id
Primary Key of the currency resource.
Nested Schema : Charge Set
Type:
object
Title:
Show Source
Charge Set
-
_bs_id:
integer
Title:
_bs_id
_bs_id -
_chargeSet_calculationInfo:
string
Title:
Calculation Information
A JSON array of the Price Models used in calculating this charge's price. -
_chargeSet_chargeDefinition:
string
Title:
Charge Definition
The display label of the charge definition. -
_chargeSet_chargeDefinitionCode:
string
Title:
Charge Definition Code
The code of the charge definition. -
_chargeSet_chargeDefIntegrationId:
string
Title:
Charge Definition Integration ID
The charge definition code in the integrated order management system. -
_chargeSet_chargeType:
object Charge Type
Title:
Charge Type
-
_chargeSet_discountAmount:
object Discount Amount
Title:
Discount Amount
The 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 Value
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. -
_chargeSet_dynamicPricingType:
string
Title:
Dynamic Pricing Type
The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced. -
_chargeSet_netAmount:
object Net Amount
Title:
Net Amount
The 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 Price
The 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 HTML
The HTML-formatted rate card data -
_chargeSet_rateCardName:
string
Title:
Rate Card
Display label for the Rate Card applied in calculating this charge's price. -
_chargeSet_rateCardStructure:
string
Title:
Rate Card Structure
The rate card used to calculate this charge's price. -
_chargeSet_rateCardVariableName:
string
Title:
Rate Card Variable Name
Variable Name for the Rate Card applied in calculating this charge's price. -
_chargeSet_unitPrice:
object Unit Price
Title:
Unit Price
The 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:
state
Captures 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:
object
Title:
Show Source
Charge Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Discount Amount
Type:
object
Title:
Discount Amount
The 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:
object
Title:
Show Source
Discount Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Net Amount
Type:
object
Title:
Net Amount
The 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:
object
Title:
Net Price
The 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:
object
Title:
Show Source
Price Period
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Unit Price
Type:
object
Title:
Unit Price
The 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:
object
Title:
Show Source
Usage UOM
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : _transaction_currency_pref
Type:
object
Title:
Show Source
_transaction_currency_pref
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency. -
id:
integer
Title:
Id
Primary Key of the currency resource.
Nested Schema : Value
Type:
object
Title:
Value
Composite attribute value
Nested Schema : Actions
Type:
object
Title:
Actions
Captures 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:
object
Title:
Attributes
Captures 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:
array
Title:
Messages
Array of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Response
Supported Media Types
- application/json
Default Response
Root Schema : TransactionLine-CalculatePriceResponse
Type:
Show Source
object
-
cacheInstanceId:
string
Title:
Cache Instance Id
The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db. -
documents:
object Transaction Line
Title:
Transaction Line
-
revisionId:
string
Title:
Revision Id
The string parameter that contains the revision information. -
warnings:
object warnings
Title:
warnings
warning messages
Nested Schema : Transaction Line
Type:
object
Title:
Show Source
Transaction Line
-
_availableRatePlans:
object Available Rate Plans
Title:
Available Rate Plans
-
_availableRatePlanSet:
object TransactionLine_availableRatePlanSet-collection
-
_availableRatePlanSetControl:
integer
Title:
Available Rate Plan Set Control
-
_bs_id:
integer
Title:
_bs_id
-
_chargeSet:
object TransactionLine_chargeSet-collection
-
_chargeSetControl:
integer
Title:
Charge Set Control
-
_config_attr_info:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_attr_text:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_attr_values:
string
Title:
Config Attribute Values
Stores configurable attributes values in a user-friendly JSON format that are passed in from the CRM partner at the time of quote creation. These values are used as a starting point when creating quote lines from opportunity revenue lines and are not updated by subsequent reconfiguration. Usage should be limited to a small number of attributes to assure performance. Only simple configuration attribute data types are supported. -
_config_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_config_extra_info:
string
Title:
Config Extra Info
Configuration Extra Information. -
_configuration_id:
string
Title:
Configuration ID
Configuration id for integrations. -
_date_added:
string
Title:
_date_added
-
_date_modified:
string
Title:
_date_modified
-
_delta_price:
object Delta Price
Title:
Delta Price
Delta Price -
_document_number:
integer
Title:
_document_number
-
_document_var_name:
string
Title:
_document_var_name
-
_group_sequence_number:
string
Title:
Group Sequence Number
Group sequence number for the subdocument. -
_id:
integer
Title:
_id
-
_is_bom_price:
boolean
Title:
Is BOM Price
Used to identify if the line item has BOM price. Applicable for a BOM item only -
_is_coverage:
boolean
Title:
Is Coverage Product
Indicates whether the product is of coverage type -
_is_line_item_mandatory:
boolean
Title:
Is Line Item Mandatory
Used to identify if the line item is mandatory. -
_is_part_pricing_rule_price:
boolean
Title:
Is Price from Pricing Rule
Used to identify if a line item has a part pricing rule set by a rule -
_is_recommended_price:
boolean
Title:
Is Price Recommended
Used to identify if the line item has recommended price set by a rule. -
_last_modified_date:
string
Title:
Last Modified Date
Used to Store the last modified date of the sub-document. -
_line_bom_attributes:
string
Title:
Line Item BOM Attributes
BOM attributes, stored as a JSON string. -
_line_bom_condition_index:
string
Title:
Line BOM Condition Index
The condition index of the BOM item -
_line_bom_display_name:
string
Title:
Line BOM Display Name
The display name of the BOM item -
_line_bom_effective_date:
string
Title:
Line BOM Effective Date
System attribute to be stored in model line effective date to drive date effectivity in all BOM mappings. -
_line_bom_id:
string
Title:
Line Item BOM ID
The BOM item instance id. -
_line_bom_item_quantity:
integer
Title:
Line BOM Item Quantity
The BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity. -
_line_bom_level:
integer
Title:
Line BOM Level
The BOM item depth (level) in the quote. -
_line_bom_model_path:
string
Title:
Line BOM Model Path
The model path of the BOM item; only applicable to the model line -
_line_bom_name:
string
Title:
Line BOM Name
The name of the BOM item -
_line_bom_parent_id:
string
Title:
Parent Line Item BOM ID
The parent BOM item instance id. -
_line_bom_part_number:
string
Title:
Line BOM Part Number
The part number of the BOM item. Only applicable to the model line. -
_line_bom_sequence_index:
string
Title:
Line BOM Sequence Index
The sequence index of the BOM item -
_line_bom_variable_name:
string
Title:
Line BOM Variable Name
The variable name of the BOM item -
_line_display_name:
string
Title:
Line Display Name
Display name attribute for line items. -
_line_item_comment:
string
Title:
Line Item Comments
Stores the comments for the line item. -
_line_item_spare_rule_var_name:
string
Title:
Line Item Identifier
Identifier returned by Spare Rule, if the Identifier is not specified the spare rule variable name is used as the identifier -
_line_item_type:
string
Title:
Line Item Type
Type attribute for line items. -
_model_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_model_base_price:
object Model Base Price
Title:
Model Base Price
Base price of the model -
_model_bom:
string
Title:
Model BOM
Model BOM Link -
_model_id:
string
Title:
Model ID
Id of the model -
_model_is_valid:
boolean
Title:
Is Model Valid
Check if model is configured or unconfigured -
_model_name:
string
Title:
Model Name
Name of the model -
_model_partner_entity_id:
string
Title:
Model Partner Entity Id
Partner entity id for the model -
_model_partner_organization_id:
string
Title:
Model Partner Organization Id
partner organization id for the model -
_model_product_line_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_model_product_line_id:
string
Title:
Model Product Line ID
Id of the Product Line to which the model belongs -
_model_product_line_name:
string
Title:
Model Product Line Name
Product Line to which the model belongs -
_model_product_line_var_name:
string
Title:
Model Product Line Variable Name
Variable name of the product line that the model belongs to. -
_model_sales_product_type:
string
Title:
Model Sales Product Type
ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_model_segment_id:
string
Title:
Model Segment ID
Id of the Segment to which the model belongs -
_model_segment_name:
string
Title:
Model Segment Name
Segment to which the model belongs -
_model_segment_var_name:
string
Title:
Model Segment Variable Name
Segment to which the model belongs -
_model_supplier_company_id:
string
Title:
Model Supplier Company ID
Model supplier company id -
_model_supplier_company_name:
string
Title:
Model Supplier Company Name
Model supplier company name -
_model_variable_name:
string
Title:
Model Variable Name
Variable name of the model -
_original_document_number:
string
Title:
Original Document Number
Used to identify the document number from which the line item is copied. -
_parent_doc_number:
string
Title:
Parent Document Number
Used to identify the parent document number, if any, for this subdocument. -
_parent_line_item:
string
Title:
Parent Line Item
Used to identify the name of the parent line item, if any, for this subdocument. -
_part_base_price:
object Part Base Price
Title:
Part Base Price
Price of the part -
_part_company_associations:
string
Title:
Company Associations
Company Associations -
_part_css_enabled:
string
Title:
Enable Customer Self-Service
Customer Self-service enabled flag -
_part_default_periodicity:
string
Title:
Part Price Period
Default Price Periodicity -
_part_default_periods:
string
Title:
Number of Price Periods
Default number of price periods -
_part_default_price_type:
string
Title:
Part Price Type
Default Price Type -
_part_default_uom:
string
Title:
Default UOM Code
Default unit of measure -
_part_desc:
string
Title:
Part Description
Description of the part -
_part_direct_buy:
string
Title:
Direct Buy
Direct Buy -
_part_display_number:
string
Title:
Part Display Number
Part Display Number -
_part_drawing_position:
string
Title:
Drawing Position
Drawing Position -
_part_extended_desc_1:
string
Title:
Part Extended Description 1
Extended description of the part -
_part_extended_desc_2:
string
Title:
Part Extended Description 2
Extended description of the part -
_part_external_key1:
string
Title:
External Key 1
External system's key -
_part_external_key2:
string
Title:
External Key 2
External system's key -
_part_id:
string
Title:
Part ID
Id of the part -
_part_lead_time:
string
Title:
Part Lead Time
Lead time -
_part_number:
string
Title:
Part Number
Part Number -
_part_sale_enabled:
string
Title:
Eligible to Sell
Eligible to sell or order -
_part_sales_product_type:
string
Title:
Sales Product Type
ProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_part_serv_req_enabled:
string
Title:
Eligible for Service
Eligible for service -
_part_supplier_company_id:
string
Title:
Part Supplier Company ID
Id of the part supplier company -
_part_supplier_company_name:
string
Title:
Part Supplier Company Name
Name of the part supplier company -
_part_units:
string
Title:
Part Units
Units of the part -
_partner_entity_id:
string
Title:
Partner Entity Id
Partner Entity Id -
_partner_organization_id:
string
Title:
Partner Organization Id
Partner Organization Id -
_pp_id:
integer
Title:
_pp_id
-
_pp_name:
string
Title:
_pp_name
-
_price_applied_agreement_integrationId:
string
Title:
Applied Agreement Integration ID
Applied Agreement Integration Id -
_price_applied_agreement_name:
string
Title:
Applied Agreement Name
Applied Agreement Name -
_price_applied_agreement_number:
string
Title:
Applied Agreement Number
Applied Agreement Number -
_price_applied_ratePlan:
string
Title:
Applied Rate Plan
Applied Rate Plan -
_price_applied_ratePlan_integrationId:
string
Title:
Applied Rate Plan Integration ID
Applied Rate Plan Integration Id -
_price_applied_ratePlan_number:
string
Title:
Applied Rate Plan Number
Applied Rate Plan Number -
_price_book_var_name:
string
Title:
Price Book Variable Name
Variable Name of the Price Book used to get the price for this line item -
_price_calculation_info:
string
Title:
Calculation Information
JSON array of aggregated calculation information returned from advanced pricing profiles -
_price_component_prices:
object Commerce Composite Attribute
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes. -
_price_configurable_price:
object Configurable Price
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium) -
_price_item_price_each:
object Item Price
Title:
Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices. -
_price_list_price_each:
object List Price
Title:
List Price
Will usually be the same value as the Item Price, unless a recommended item price applies. -
_price_period:
string
Title:
Pricing Engine Price Period
Period for which the price will be applicable. -
_price_quantity:
integer
Title:
Quantity
Quantity -
_price_type:
string
Title:
Pricing Engine Price Type
Type of price (For example: One-time, Periodic - monthly, quarterly etc) -
_price_unit_price_each:
object Unit Price
Title:
Unit Price
Will usually be the same value as the List Price, unless a contract price applies. -
_pricing_rule_price_each:
object Pricing Rule Price
Title:
Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models) -
_prior_price:
object Prior Price
Title:
Prior Price
Prior Price -
_reconfiguration_date:
string
Title:
Reconfiguration Date
Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model. -
_revenueCategory_l:
object Revenue Category
Title:
Revenue Category
-
_revenueId_l:
string
Title:
Revenue ID
The ID of the Revenue Line Item in the associated opportunity. -
_rollup_delta_price:
object Rollup Delta Price
Title:
Rollup Delta Price
Rollup Delta Price -
_s_coverageLineNumber:
string
Title:
Coverage Line Number
Source line number of the coverage line for OM Integration. -
_s_coverageOrderNumber:
string
Title:
Coverage Order Number
Source order number of the coverage line for OM Integration. -
_s_freezeNegotiationFlag_l:
boolean
Title:
Freeze Negotiation Flag
Flag indicating whether price negotiation is permitted. -
_s_partID_l:
string
Title:
Part ID
Part number from the Items table. -
_sequence_number:
integer
Title:
Sequence Number
Sequence number for the subdocument. -
_state:
object state
Title:
state
Captures 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. -
_step_var_name:
string
Title:
_step_var_name
-
_transaction_currency_pref:
string
Title:
_transaction_currency_pref
-
_transactionLine_id:
string
Title:
Transaction Line ID
Unique identifier for this subdocument. -
annualCost_l:
object Annual Cost
Title:
Annual Cost
The extended cost for recurring pricing on this transaction line. -
annualDiscount_l:
object Annual Discount
Title:
Annual Discount
The annual discount on the recurring charges on this line. -
annualListValue_l:
object Annual Value (List)
Title:
Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods. -
annualMargin_l:
object Annual Margin
Title:
Annual Margin
The extended margin for recurring pricing on this transaction line. -
annualValue_l:
object Annual Value (Net)
Title:
Annual Value (Net)
The annual contract value of the recurring charges on this line. -
associatedLineId_l:
string
Title:
Associated Line Id
Document number to be associated with the subscription line. -
associatedOrderId_l:
string
Title:
Associated Order Id
Source order Id associated with the subscription line -
cancelReason_l:
object Cancel Reason
Title:
Cancel Reason
-
changeCode_l:
object Change Code
Title:
Change Code
-
changeReason_l:
object Change Reason
Title:
Change Reason
-
contractCost_l:
object Contract Cost
Title:
Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs. -
contractDiscount_l:
object Contract Discount
Title:
Contract Discount
The total discount of this line including all one-time and recurring charges. -
contractedPeriods_l:
integer
Title:
Contracted Periods
Number of periods the customer has contracted to receive the item. -
contractedPeriodsRollup_l:
integer
Title:
Contracted Periods (Rollup)
Number of periods the customer has contracted to receive the item or for the root model rolled up to include all child values. -
contractEndDate_l:
string
Title:
Contract End Date
Date that the customer stops to receive the service. -
contractListValue_l:
object Contract Value (List)
Title:
Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges. -
contractListValueRollup_l:
object Contract Value (List Rollup)
Title:
Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines. -
contractMargin_l:
object Contract Margin
Title:
Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values. -
contractStartDate_l:
string
Title:
Contract Start Date
Date that the customer starts to receive the service. -
contractValue_l:
object Contract Value (Net Summable)
Title:
Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges. -
contractValueRollup_l:
object Contract Value (Net Rollup)
Title:
Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines. -
costAmount_l:
object Cost Amount
Title:
Cost Amount
The total cost of this line. -
createdBy_l:
string
Title:
Created By
The person that created the transaction line. -
createdDate_l:
string
Title:
Created Date
The date when the transaction line was created. -
customDiscountAmount_l:
object Custom Discount Amount
Title:
Custom Discount Amount
The amount by which to adjust the list price because of a custom discount. -
customDiscountType_l:
object Discount Type
Title:
Discount Type
-
customDiscountValue_l:
number
Title:
Discount
Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage. -
discountAmount_l:
object Amount (Discount)
Title:
Amount (Discount)
The discount amount for this line. -
discountPercent_l:
number
Title:
Discount %
The percentage of the Contract Value (List) that is discounted off of the transaction line. -
discountPercentRollup_l:
number
Title:
Discount Percent (Rollup)
The percentage of the Contract Value (List) that is discounted off of the transaction line or for the root model rolled up to include all child values. -
documentNumber_l:
string
Title:
Document Number
Document number of the line. -
fulfillmentLineId_l:
string
Title:
Fulfillment Line Id
Value that uniquely identifies the fulfillment line. -
fulfillmentOrganizationCode_l:
string
Title:
Fulfillment Organization Code
Abbreviation that identifies the organization that ships the shipment. -
fulfillmentStatus_l:
object Fulfillment Status
Title:
Fulfillment Status
-
includedInBasePrice:
boolean
Title:
Included In Base Price
Used to identify if the line item is included in the base price. Applicable for a BOM item only. -
itemInstanceId_l:
string
Title:
Instance ID
The unique, invariant, internal identifier of this instance of a product. It is used to link sales order lines to the assets they change in an asset based order and as the key stored in a sales order line association. This ID is assigned when the product instance is created in either an external federated asset repository or in CPQ when a sales order line is created. -
itemInstanceName_l:
string
Title:
Instance Name
The public identifier of the instance of a product. For goods this is typically the serial #. For services it might be another identifier such as the telephone #. This does not have to be unique across all product instances (e.g. a cell phone # may be reallocated over time). It is one of the primary attributes for searching for a product instance. -
lastUpdatedBy_l:
string
Title:
Last Updated By
The person that last updated this transaction line. -
lastUpdatedDate_l:
string
Title:
Last Updated
The date and time the transaction line was last updated. -
lineNumber_l:
integer
Title:
Line Number
Line number in a line item grid is a sequential number assigned to each row or line of the grid. This is used to sort lines on the screen and in documents. -
lineType_l:
object Line Type
Title:
Line Type
-
listAmount_l:
object Amount (List)
Title:
Amount (List)
The extended list amount for this line. -
listPrice_l:
object Price (List)
Title:
Price (List)
The list price of the item. -
listPriceRollup_l:
object List Price (Rollup)
Title:
List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values. -
marginAmount_l:
object Margin Amount
Title:
Margin Amount
The margin for all quoted units of this transaction line. -
marginPercent_l:
number
Title:
Margin %
The percentage of the List price for which this transaction line's margin accounts. -
monthlyRecurRevRollup_l:
object MRR (Rollup)
Title:
MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines. -
monthlyRecurRevSummable_l:
object MRR (Summable)
Title:
MRR (Summable)
Monthly recurring revenues net of all discounts for this line. -
monthlyUsageRevRollup_l:
object MUR (Rollup)
Title:
MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines. -
monthlyUsageRevSummable_l:
object MUR (Summable)
Title:
MUR (Summable)
Monthly usage revenues net of all discounts for this line. -
netAmount_l:
object Amount (Net)
Title:
Amount (Net)
The extended list amount minus any discounts for this line. -
netAmountRollup_l:
object Net Amount (Rollup)
Title:
Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values. -
netPrice_l:
object Price (Net)
Title:
Price (Net)
The price paid by the customer for the item. -
netPriceRollup_l:
object Net Price (Rollup)
Title:
Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values. -
nonRecurRevRollup_l:
object Non-Recurring Revenue (Rollup)
Title:
Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines. -
nonRecurRevSummable_l:
object Non-Recurring Revenue (Summable)
Title:
Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line. -
oRCL_ABO_ActionCode_l:
object Action Code
Title:
Action Code
-
oRCL_ABO_ComponentAttributes_l:
string
Title:
Component Attributes
A comma separated collection of key / value pair attributes that define the configuration of this asset / component plus an action code indicating whether the attribute has changed. -
oRCL_ERP_OrderNumber_l:
string
Title:
Order Number
The order number assigned by the external Order Management and ERP system. -
oRCL_SFA_InventoryItemID_l:
string
Title:
Inventory Item ID
The inventory item id of the sales product in SFA. -
oRCL_SFA_InventoryOrgID_l:
string
Title:
Partner Orgnanization ID
The inventory organization in SFA used for sales products. -
oRCL_SFA_Status_l:
string
Title:
Opportunity Win/Loss Status (Line)
The SFA status of the transaction line. This value may differ from the transaction status for CPQ. Initially, there is no internal logic setting this value. -
orderDate_l:
string
Title:
Order Date
The date and time the order was placed for fulfillment. -
ownerResourceId_l:
string
Title:
Owner Resource ID
The owner of the associated Opportunity Revenue Line. -
parentAssetKey_l:
string
Title:
Parent Asset Key
The identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines. -
parentDocNumber_l:
string
Title:
Parent Doc Number
Document number of the parent line item. -
paymentTerms_l:
object Payment Terms
Title:
Payment Terms
-
pricePeriod_l:
object Period
Title:
Period
-
priceRecurFrequency_l:
object Price Recurrence Frequency
Title:
Price Recurrence Frequency
-
priceRecurFrequencyRollup_l:
object Price Recurrence Frequency (Rollup)
Title:
Price Recurrence Frequency (Rollup)
-
priceScore_l:
integer
Title:
Price Score
The calculated price score for this transaction line, based on the line item's List and Net pricing. -
priceType_l:
object Price Type
Title:
Price Type
-
priceTypeRollup_l:
object Price Type (Rollup)
Title:
Price Type (Rollup)
-
priceWithinPolicy_l:
boolean
Title:
Price Within Policy
Flag which indicates if line price is within requesting user's defined pricing limits -
recurRevRollup_l:
object Recurring Revenue (Rollup)
Title:
Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines. -
recurringRevSummable_l:
object Recurring Revenue (Summable)
Title:
Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line. -
renewDate_l:
string
Title:
Renew Date
Renewal date of a subscription service. -
requestDate_l:
string
Title:
Request Date
The date on which the user requests that fulfillment occur for this transaction line. -
requestedUnitOfMeasure_l:
object Unit of Measure
Title:
Unit of Measure
-
requestShipDate_l:
string
Title:
Request Ship Date
The requested ship date for the order line. -
resumeDate_l:
string
Title:
Resume Date
Resuming date of a subscription service -
rollupFlag_l:
boolean
Title:
Rollup Flag
Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price. -
rootAssetKey_l:
string
Title:
RootAssetKey
-
rootLine_l:
object Root Line
Title:
Root Line
-
salesChannel_l:
object Sales Channel
Title:
Sales Channel
-
status_l:
object Status
Title:
Status
-
subscriptionId_l:
string
Title:
Subscription Id
The unique identifier for the subscription. Used only for subscription billing-related transactions. -
subscriptionLineId_l:
string
Title:
Subscription Line Id
The unique identifier for the subscription line. Used only for subscription billing-related transactions. -
suspendDate_l:
string
Title:
Suspend Date
Suspension date of a subscription service -
transactionID_l:
string
Title:
Transaction Internal ID
The parent transaction's internal ID. -
unitCost_l:
object Unit Cost
Title:
Unit Cost
The unit cost of the item. -
unitMargin_l:
object Margin
Title:
Margin
The margin for a single unit of this transaction line. -
usageRevRollup_l:
object Usage Revenue (Rollup)
Title:
Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines. -
usageRevSummable_l:
object Usage Revenue (Summable)
Title:
Usage Revenue (Summable)
Usage revenue net of all discounts for this line. -
winLossStatus_l:
object Win/Loss Status
Title:
Win/Loss Status
Nested Schema : warnings
Type:
object
Title:
warnings
warning messages
Show Source
-
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object.
Nested Schema : Available Rate Plans
Type:
object
Title:
Show Source
Available Rate Plans
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : TransactionLine_availableRatePlanSet-collection
Type:
Show Source
object
-
_state:
object state
Title:
state
Captures 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 : TransactionLine_chargeSet-collection
Type:
Show Source
object
-
_state:
object state
Title:
state
Captures 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 : Commerce Composite Attribute
Type:
object
Title:
Commerce Composite Attribute
Composite attribute is used to display one or more fields belonging to a family of attributes.
Show Source
-
value:
object Value
Title:
Value
Composite attribute value
Nested Schema : Delta Price
Type:
object
Title:
Delta Price
Delta Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Model Base Price
Type:
object
Title:
Model Base Price
Base price of the model
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Part Base Price
Type:
object
Title:
Part Base Price
Price of the part
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Configurable Price
Type:
object
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium)
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Item Price
Type:
object
Title:
Item Price
The starting price. For Parts it will be the base price or price book price. For models it may be the base model price or the pricing rule or attribute value prices.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : List Price
Type:
object
Title:
List Price
Will usually be the same value as the Item Price, unless a recommended item price applies.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Unit Price
Type:
object
Title:
Unit Price
Will usually be the same value as the List Price, unless a contract price applies.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Pricing Rule Price
Type:
object
Title:
Pricing Rule Price
Currenly the customer level pricing. (Not applicable for Models)
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Prior Price
Type:
object
Title:
Prior Price
Prior Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Revenue Category
Type:
object
Title:
Show Source
Revenue Category
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Rollup Delta Price
Type:
object
Title:
Rollup Delta Price
Rollup Delta Price
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : state
Type:
object
Title:
state
Captures 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:
Actions
Captures 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:
Attributes
Captures 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:
Deletable
Boolean value that specifies whether the row can be deleted. -
hasError:
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the row itself. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
updatable:
boolean
Title:
Updatable
Boolean value that specifies whether the row can be updated.
Nested Schema : Annual Cost
Type:
object
Title:
Annual Cost
The extended cost for recurring pricing on this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Discount
Type:
object
Title:
Annual Discount
The annual discount on the recurring charges on this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Value (List)
Type:
object
Title:
Annual Value (List)
The extended value at list price for recurring pricing on this transaction line over the duration of the contracted periods.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Margin
Type:
object
Title:
Annual Margin
The extended margin for recurring pricing on this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Value (Net)
Type:
object
Title:
Annual Value (Net)
The annual contract value of the recurring charges on this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Cancel Reason
Type:
object
Title:
Show Source
Cancel Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Change Code
Type:
object
Title:
Show Source
Change Code
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Change Reason
Type:
object
Title:
Show Source
Change Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Contract Cost
Type:
object
Title:
Contract Cost
The total of all contract extended costs for this line, including one-time and recurring costs.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Discount
Type:
object
Title:
Contract Discount
The total discount of this line including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (List)
Type:
object
Title:
Contract Value (List)
The total of all contract list value of this line, including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (List Rollup)
Type:
object
Title:
Contract Value (List Rollup)
Contract list value on this line or for the root model lines, the sum of all contract list values for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Margin
Type:
object
Title:
Contract Margin
The total of all contract extended margins for this line, including one-time and recurring values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (Net Summable)
Type:
object
Title:
Contract Value (Net Summable)
The total contract value of this line including all one-time and recurring charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Contract Value (Net Rollup)
Type:
object
Title:
Contract Value (Net Rollup)
Contract value on this line or for the root model lines, the sum of all contract revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Cost Amount
Type:
object
Title:
Cost Amount
The total cost of this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Custom Discount Amount
Type:
object
Title:
Custom Discount Amount
The amount by which to adjust the list price because of a custom discount.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Discount Type
Type:
object
Title:
Show Source
Discount Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Amount (Discount)
Type:
object
Title:
Amount (Discount)
The discount amount for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Fulfillment Status
Type:
object
Title:
Show Source
Fulfillment Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Line Type
Type:
object
Title:
Show Source
Line Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Amount (List)
Type:
object
Title:
Amount (List)
The extended list amount for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Price (List)
Type:
object
Title:
Price (List)
The list price of the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : List Price (Rollup)
Type:
object
Title:
List Price (Rollup)
The list price of the item or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Margin Amount
Type:
object
Title:
Margin Amount
The margin for all quoted units of this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MRR (Rollup)
Type:
object
Title:
MRR (Rollup)
Monthly recurring revenue on this line or for the root model lines, the sum of monthly recurring revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MRR (Summable)
Type:
object
Title:
MRR (Summable)
Monthly recurring revenues net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MUR (Rollup)
Type:
object
Title:
MUR (Rollup)
Monthly usage revenue on this line or for the root model lines, the sum of monthly usage revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : MUR (Summable)
Type:
object
Title:
MUR (Summable)
Monthly usage revenues net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Amount (Net)
Type:
object
Title:
Amount (Net)
The extended list amount minus any discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Net Amount (Rollup)
Type:
object
Title:
Net Amount (Rollup)
The extended list amount minus any discounts for this line or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Price (Net)
Type:
object
Title:
Price (Net)
The price paid by the customer for the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Net Price (Rollup)
Type:
object
Title:
Net Price (Rollup)
The price paid by the customer for the individual item or for the root model rolled up to include all child values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Non-Recurring Revenue (Rollup)
Type:
object
Title:
Non-Recurring Revenue (Rollup)
One-time revenue on this line or for the root model lines, the sum of one-time revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Non-Recurring Revenue (Summable)
Type:
object
Title:
Non-Recurring Revenue (Summable)
One-time revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Action Code
Type:
object
Title:
Show Source
Action Code
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Payment Terms
Type:
object
Title:
Show Source
Payment Terms
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Period
Type:
object
Title:
Show Source
Period
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency
Type:
object
Title:
Show Source
Price Recurrence Frequency
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency (Rollup)
Type:
object
Title:
Show Source
Price Recurrence Frequency (Rollup)
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type (Rollup)
Type:
object
Title:
Show Source
Price Type (Rollup)
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Recurring Revenue (Rollup)
Type:
object
Title:
Recurring Revenue (Rollup)
Recurring revenue on this line or for the root model lines, the sum of recurring revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Recurring Revenue (Summable)
Type:
object
Title:
Recurring Revenue (Summable)
Recurring revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Unit of Measure
Type:
object
Title:
Show Source
Unit of Measure
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Root Line
Type:
object
Title:
Show Source
Root Line
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sales Channel
Type:
object
Title:
Show Source
Sales Channel
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Status
Type:
object
Title:
Show Source
Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Unit Cost
Type:
object
Title:
Unit Cost
The unit cost of the item.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Margin
Type:
object
Title:
Margin
The margin for a single unit of this transaction line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Usage Revenue (Rollup)
Type:
object
Title:
Usage Revenue (Rollup)
Usage revenue on this line or for the root model lines, the sum of usage revenues for all the child lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Usage Revenue (Summable)
Type:
object
Title:
Usage Revenue (Summable)
Usage revenue net of all discounts for this line.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Win/Loss Status
Type:
object
Title:
Show Source
Win/Loss Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : state
Type:
object
Title:
state
Captures 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:
Actions
Captures 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:
state
Captures 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 Users
Details 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 Error
Boolean value that specifies whether any error that occurred has been assigned to the collection itself. -
hasWarning:
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the collection itself. -
insertable:
boolean
Title:
Insertable
Boolean value that specifies whether new rows can be inserted into the collection. -
messages:
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
queryable:
boolean
Title:
Queryable
Boolean value that specifies whether the rows in the collection can be queried. -
sortable:
boolean
Title:
Sortable
Boolean value that specifies whether the rows in the collection can be sorted.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Available Rate Plan Set
Title:
Available Rate Plan Set
Nested Schema : Actions
Type:
object
Title:
Actions
Captures 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 : Focused Users
Type:
object
Title:
Focused Users
Details 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:
array
Title:
Messages
Array of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Available Rate Plan Set
Type:
object
Title:
Show Source
Available Rate Plan Set
-
_availableRatePlanSet_rate_plan_integration_id:
string
Title:
Available Rate Plan Integration Id
Rate Plan Integration ID -
_availableRatePlanSet_rate_plan_name:
string
Title:
Available Rate Plan Name
Rate plan name -
_availableRatePlanSet_rate_plan_number:
string
Title:
Available Rate Plan Number
Rate Plan Number -
_bs_id:
integer
Title:
_bs_id
_bs_id -
_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:
state
Captures 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 : _transaction_currency_pref
Type:
object
Title:
Show Source
_transaction_currency_pref
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency. -
id:
integer
Title:
Id
Primary Key of the currency resource.
Nested Schema : Charge Set
Type:
object
Title:
Show Source
Charge Set
-
_bs_id:
integer
Title:
_bs_id
_bs_id -
_chargeSet_calculationInfo:
string
Title:
Calculation Information
A JSON array of the Price Models used in calculating this charge's price. -
_chargeSet_chargeDefinition:
string
Title:
Charge Definition
The display label of the charge definition. -
_chargeSet_chargeDefinitionCode:
string
Title:
Charge Definition Code
The code of the charge definition. -
_chargeSet_chargeDefIntegrationId:
string
Title:
Charge Definition Integration ID
The charge definition code in the integrated order management system. -
_chargeSet_chargeType:
object Charge Type
Title:
Charge Type
-
_chargeSet_discountAmount:
object Discount Amount
Title:
Discount Amount
The 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 Value
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. -
_chargeSet_dynamicPricingType:
string
Title:
Dynamic Pricing Type
The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced. -
_chargeSet_netAmount:
object Net Amount
Title:
Net Amount
The 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 Price
The 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 HTML
The HTML-formatted rate card data -
_chargeSet_rateCardName:
string
Title:
Rate Card
Display label for the Rate Card applied in calculating this charge's price. -
_chargeSet_rateCardStructure:
string
Title:
Rate Card Structure
The rate card used to calculate this charge's price. -
_chargeSet_rateCardVariableName:
string
Title:
Rate Card Variable Name
Variable Name for the Rate Card applied in calculating this charge's price. -
_chargeSet_unitPrice:
object Unit Price
Title:
Unit Price
The 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:
state
Captures 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:
object
Title:
Show Source
Charge Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Discount Amount
Type:
object
Title:
Discount Amount
The 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:
object
Title:
Show Source
Discount Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Net Amount
Type:
object
Title:
Net Amount
The 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:
object
Title:
Net Price
The 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:
object
Title:
Show Source
Price Period
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Unit Price
Type:
object
Title:
Unit Price
The 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:
object
Title:
Show Source
Usage UOM
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : _transaction_currency_pref
Type:
object
Title:
Show Source
_transaction_currency_pref
-
currencyCode:
string
Title:
Currency Code
Unique currency code for the currency. -
id:
integer
Title:
Id
Primary Key of the currency resource.
Nested Schema : Value
Type:
object
Title:
Value
Composite attribute value
Nested Schema : Actions
Type:
object
Title:
Actions
Captures 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:
object
Title:
Attributes
Captures 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:
array
Title:
Messages
Array of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Messages
Type:
array
Title:
Messages
Array of messages that have been generated for a specific object.
Show Source
-
Array of:
string
warning message.
Examples
The following example shows how to re-calculate pricing data, after a pricing field is modified, by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18016533/transactionLine/3/actions/_calculate_price_action
Request Body Sample
{ "documents": { "_price_quantity": 10, "_price_override_quantity": true, "_price_item_price_each": { "value": 11, "currency": "USD" }, "_pricing_rule_price_each": { "value": 14, "currency": "USD" }, "_price_unit_price_each": { "value": 15, "currency": "USD" }, "_price_override_price": { "value": "Yes", "displayValue": "Yes" }, "_price_discount_percent": 18, "_price_override_discount": { "value": "Percent", "displayValue": "Percent" } } }
Response: The response contains the JSON Transaction data.
Notes:
- The Override Price attribute should be set to Yes to allow overrides when invoking the REST to perform recalculation.
- If Override Price is set to No and there are new price values, the values will be reset to the original values and returned via the REST API. There will be no warning or error message when new values are provided for recalculation.
- The recalculated values returned via the REST API are not saved in the database until a modify type action is invoked.