Back From Transaction Line
post
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/back_l
This action is invoked from a Transaction Line, and returns the user to the Transaction.
Request
Path Parameters
-
MainDocVarName: string
The variable name of the main document, the first letter must be capitalized
-
ProcessVarName: string
The variable name of the Commerce process, the first letter must be capitalized
-
_id: integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
-
subDocNumber: string
Unique document number for this sub doc to be used as document identifier in a commerce process
-
subDocVarName: string
The variable name of the sub-document
Root Schema : commerceTransactionLine-ModifyRequest
Type:
Show Source
object
-
cacheInstanceId(optional):
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(optional):
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
delta(optional):
boolean
Title:
Delta
When the delta parameter is enabled and an action is invoked, only the data and state properties that have changed from the cache image are included in the response. Delta data is only calculated for the requested criteria. -
documents(optional):
object commerceTransactionLine
-
selections(optional):
array selections
-
skipIntegration(optional):
boolean
Title:
Skip Integration
When this parameter is passed in the payload as true, system will not run the integration XSLs. If the parameter is not present in the request, default behavior will be to run the integration XSLs.
Nested Schema : Query Definition
Type:
object
Title:
Query Definition
Captures the query definition for the current resource request.
Show Source
-
actions(optional):
array actions
Array of actions names, whose state is requested in the state object response.
-
childDefs(optional):
array childDefs
-
enableHierarchy(optional):
boolean
Parameter value should be true to execute hierarchy search and sort. Default value is false.
-
excludeFieldTypes(optional):
array excludeFieldTypes
Array of field names that you want to exclude in the response.
-
expand(optional):
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(optional):
array expandedDomains
Array of field names, whose expanded domains are requested in the state object response.
-
expandNodes(optional):
boolean
Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
-
fields(optional):
array fields
Array of field names that you wanted returned in a request.
-
groups(optional):
array groups
Array of group names, whose state is requested in the state object response.
-
limit(optional):
integer
Positive integer value that specifies the maximum number of items returned by the server.
-
nodesExceptionList(optional):
array nodesExceptionList
Array of document_number, recording the nodes that violate current expandNodes flag
-
offset(optional):
integer
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy(optional):
array orderBy
Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q(optional):
string
Filter (a ??where??clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
state(optional):
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.
-
totalResults(optional):
boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
Nested Schema : commerceTransactionLine
Type:
Show Source
object
-
_config_attr_info(optional):
string
Title:
Config Attribute Information
Configurable Attribute Information is populated with variable name, attribute name, data type and menu type information. -
_config_attr_text(optional):
string
Title:
Config Attribute Text
Configurable Attribute Text format is similar Configurable Attribute.The only difference is that the values correspond to the display text of the attributes. -
_config_attributes(optional):
string
Title:
Config Attributes
Configurable Attribute is a composite attribute.This attribute is always read only. However Reconfigure action may be used to modify the values. -
_config_extra_info(optional):
string
Title:
Config Extra Info
Configuration Extra Information. -
_date_added(optional):
string
Title:
Date Added
The date when the transaction line record got added. -
_date_modified(optional):
string
Title:
Date Last Modified
The date when the transaction line record got modified. -
_document_number(optional):
integer
Title:
Document Number
Unique document number for this sub doc to be used as document identifier in a commerce process. -
_document_var_name(optional):
string
Title:
Document Variable Name
This is the document variable name.A document can either be a 'Main Document' or 'SubDocument - Transaction Line'. Variable name for the main document is 'transaction' and for the sub document, it is 'transactionLine'. Main (Header Level) Commerce Document serves as Quote/Order depending on step in process flow. -
_id(optional):
integer
Title:
Internal Transaction Line ID
Unique id for a transaction line item. -
_is_line_item_mandatory(optional):
boolean
Title:
Is Line Item Mandatory
Used to identify if the line item is mandatory. -
_is_part_pricing_rule_price(optional):
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(optional):
boolean
Title:
Is Price Recommended
Used to identify if the line item has recommended price set by a rule. -
_last_modified_date(optional):
string
Title:
Last Modified Date
Used to Store the last modified date of the sub-document. -
_line_bom_attributes(optional):
string
Title:
Line Item BOM Attributes
BOM attributes, stored as a JSON string. -
_line_bom_effective_date(optional):
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(optional):
string
Title:
Line Item BOM ID
The BOM item instance id. -
_line_bom_item_quantity(optional):
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(optional):
integer
Title:
Line BOM Level
The BOM item depth (level) in the quote. -
_line_bom_parent_id(optional):
string
Title:
Parent Line Item BOM ID
The parent BOM item instance id. -
_line_bom_part_number(optional):
string
Title:
Line BOM Part Number
The part number of the BOM item. Only applicable to the model line. -
_line_item_comment(optional):
string
Title:
Line Item Comments
Stores the comments for the line item. -
_line_item_spare_rule_var_name(optional):
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 -
_model_attributes(optional):
string
Title:
Model Attributes
Placeholder for all model attributes -
_model_base_price(optional):
object Model Base Price
Title:
Model Base Price
Base price of the model -
_model_bom(optional):
string
Title:
Model BOM
Model BOM Link -
_model_id(optional):
string
Title:
Model ID
Id of the model -
_model_name(optional):
string
Title:
Model Name
Name of the model -
_model_product_line_attributes(optional):
string
Title:
Model Product Line Attributes
Product Line Attributes of Product Line to which the model belongs -
_model_product_line_id(optional):
string
Title:
Model Product Line ID
Id of the Product Line to which the model belongs -
_model_product_line_name(optional):
string
Title:
Model Product Line Name
Product Line to which the model belongs -
_model_product_line_var_name(optional):
string
Title:
Model Product Line Variable Name
Variable name of the product line that the model belongs to. -
_model_segment_id(optional):
string
Title:
Model Segment ID
Id of the Segment to which the model belongs -
_model_segment_name(optional):
string
Title:
Model Segment Name
Segment to which the model belongs -
_model_segment_var_name(optional):
string
Title:
Model Segment Variable Name
Segment to which the model belongs -
_model_supplier_company_id(optional):
string
Title:
Model Supplier Company ID
Model supplier company id -
_model_supplier_company_name(optional):
string
Title:
Model Supplier Company Name
Model supplier company name -
_model_variable_name(optional):
string
Title:
Model Variable Name
Variable name of the model -
_original_document_number(optional):
string
Title:
Original Document Number
Used to identify the document number from which the line item is copied. -
_parent_doc_number(optional):
string
Title:
Parent Document Number
Used to identify the parent document number, if any, for this subdocument. -
_parent_line_item(optional):
string
Title:
Parent Line Item
Used to identify the name of the parent line item, if any, for this subdocument. -
_part_base_price(optional):
object Part Base Price
Title:
Part Base Price
Price of the part -
_part_company_associations(optional):
string
Title:
Company Associations
Company Associations -
_part_custom_field1(optional):
string
Title:
Part Custom Field1
Custom Field1 -
_part_custom_field10(optional):
string
Title:
Part Custom Field10
Custom Field10 -
_part_custom_field11(optional):
string
Title:
Part Custom Field11
Custom Field11 -
_part_custom_field12(optional):
string
Title:
Part Custom Field12
Custom Field12 -
_part_custom_field13(optional):
string
Title:
Part Custom Field13
Custom Field13 -
_part_custom_field14(optional):
string
Title:
Part Custom Field14
Custom Field14 -
_part_custom_field15(optional):
string
Title:
Part Custom Field15
Custom Field15 -
_part_custom_field16(optional):
string
Title:
Part Custom Field16
Custom Field16 -
_part_custom_field17(optional):
string
Title:
Part Custom Field17
Custom Field17 -
_part_custom_field18(optional):
string
Title:
Part Custom Field18
Custom Field18 -
_part_custom_field19(optional):
string
Title:
Part Custom Field19
Custom Field19 -
_part_custom_field2(optional):
string
Title:
Part Custom Field2
Custom Field2 -
_part_custom_field20(optional):
string
Title:
Part Custom Field20
Custom Field20 -
_part_custom_field21(optional):
string
Title:
Part Custom Field21
Custom Field21 -
_part_custom_field22(optional):
string
Title:
Part Custom Field22
Custom Field22 -
_part_custom_field23(optional):
string
Title:
Part Custom Field23
Custom Field23 -
_part_custom_field24(optional):
string
Title:
Part Custom Field24
Custom Field24 -
_part_custom_field25(optional):
string
Title:
Part Custom Field25
Custom Field25 -
_part_custom_field26(optional):
string
Title:
Part Custom Field26
Custom Field26 -
_part_custom_field27(optional):
string
Title:
Part Custom Field27
Custom Field27 -
_part_custom_field28(optional):
string
Title:
Part Custom Field28
Custom Field28 -
_part_custom_field29(optional):
string
Title:
Part Custom Field29
Custom Field29 -
_part_custom_field3(optional):
string
Title:
Part Custom Field3
Custom Field3 -
_part_custom_field30(optional):
string
Title:
Part Custom Field30
Custom Field30 -
_part_custom_field4(optional):
string
Title:
Part Custom Field4
Price Period -
_part_custom_field5(optional):
number
Title:
Part Custom Field5
Custom Field5 -
_part_custom_field6(optional):
number
Title:
Part Custom Field6
Custom Field6 -
_part_custom_field7(optional):
number
Title:
Part Custom Field7
Custom Field7 -
_part_custom_field8(optional):
string
Title:
Price Type
Custom Field8 -
_part_custom_field9(optional):
string
Title:
Part Custom Field9
Custom Field9 -
_part_desc(optional):
string
Title:
Part Description
Description of the part -
_part_direct_buy(optional):
string
Title:
Direct Buy
Direct Buy -
_part_display_number(optional):
string
Title:
Part Display Number
Part Display Number -
_part_drawing_position(optional):
string
Title:
Drawing Position
Drawing Position -
_part_extended_desc_1(optional):
string
Title:
Part Extended Description 1
Extended description of the part -
_part_extended_desc_2(optional):
string
Title:
Part Extended Description 2
Extended description of the part -
_part_id(optional):
string
Title:
Part ID
Id of the part -
_part_lead_time(optional):
string
Title:
Part Lead Time
Lead time -
_part_number(optional):
string
Title:
Part Number
Part Number -
_part_supplier_company_id(optional):
string
Title:
Part Supplier Company ID
Id of the part supplier company -
_part_supplier_company_name(optional):
string
Title:
Part Supplier Company Name
Name of the part supplier company -
_part_units(optional):
string
Title:
Part Units
Units of the part -
_partner_entity_id(optional):
string
Title:
Partner Entity Id
Partner Entity Id -
_price_book_var_name(optional):
string
Title:
Price Book Variable Name
Variable Name of the Price Book used to get the price for this line item -
_price_component_prices(optional):
string
Title:
Component Prices
Additional prices based on configuration -
_price_configurable_price(optional):
object Configurable Price
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium) -
_price_discount_comment(optional):
string
Title:
Discount Comment
Discount description -
_price_discount_percent(optional):
number
Title:
Discount %
Discount in percentage -
_price_item_price_each(optional):
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(optional):
object List Price
Title:
List Price
Will usually be the same value as the Item Price, unless a recommended item price applies. -
_price_net_price(optional):
object Net Price
Title:
Net Price
Net price is subtotal minus the total discount -
_price_override_discount(optional):
object Override Discount
Title:
Override Discount
Override original discount -
_price_override_price(optional):
object Override Price
Title:
Override Price
Override original list price -
_price_override_quantity(optional):
boolean
Title:
Override Quantity
Override original quantity -
_price_quantity(optional):
integer
Title:
Quantity
Quantity -
_price_subtotal(optional):
string
Title:
Subtotal
Subtotal -
_price_total_discount(optional):
object Total Discount
Title:
Total Discount
Total discount amount -
_price_unit_price_each(optional):
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(optional):
object Pricing Rule Price
Title:
Pricing Rule Price
Currently the customer level pricing. (Not applicable for Models) -
_reconfiguration_date(optional):
string
Title:
Reconfiguration Date
Used to Store the Reconfiguration Date of the model. -1 for Part and non-configured Model. -
_state(optional):
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(optional):
string
Title:
Transaction Currency
The code value for the transaction currency. -
actualAmount_l(optional):
object Actual Amount
Title:
Actual Amount
The actual amount billed to the customer. -
actualQuantity_l(optional):
integer
Title:
Actual Quantity
The actual quantity provided to the customer. -
annualDiscount_l(optional):
object Annual Discount
Title:
Annual Discount
The annual discount on the recurring charges on this line. -
annualValue_l(optional):
object Annual Value
Title:
Annual Value
The annual contract value of the recurring charges on this line. -
bs_id(optional):
string
Title:
Transaction ID
The unique identifier for a Transaction within a CPQ site. -
cancelReason_l(optional):
object Cancel Reason
Title:
Cancel Reason
The reason why the customer cancelled this line. -
canChangeConfiguration_l(optional):
boolean
Title:
Can Change Configuration
Indicates whether the fulfillment system can support a change to the configuration of this line. -
canChangeQuantity_l(optional):
boolean
Title:
Can Change Quantity
Indicates whether the fulfillment system can support a change to the quantity of this line. -
contractDiscount_l(optional):
object Contract Discount
Title:
Contract Discount
The total discount of this line including all one - time and recurring charges. -
contractedPeriods_l(optional):
integer
Title:
Contracted Periods
Number of periods the customer has contracted to receive the item. -
contractEndDate_l(optional):
string
Title:
Contract End Date
Date that the customer stops to receive the service. -
contractStartDate_l(optional):
string
Title:
Contract Start Date
Date that the customer starts to receive the service. -
contractValue_l(optional):
object Contract Value
Title:
Contract Value
The total contract value of this line including all one - time and recurring charges. -
costAmount_l(optional):
object Cost Amount
Title:
Cost Amount
The total cost of this line. -
createdBy_l(optional):
string
Title:
Created By
The person that created the transaction line. -
createdDate_l(optional):
string
Title:
Created Date
The date when the transaction line was created. -
customDiscountAmount_l(optional):
object Custom Discount Amount
Title:
Custom Discount Amount
The amount by which to adjust the list price because of a custom discount. -
customDiscountType_l(optional):
object Discount Type
Title:
Discount Type
The type of custom discount to apply to this line. -
customDiscountValue_l(optional):
number
Title:
Discount
Used to capture the numeric value associated with the discount type. This might be an override price, amount off or percentage. -
customerItemName_l(optional):
string
Title:
Customer Item Name
Customer supplied item name.This is displayed on reports and in the UI. -
discountAmount_l(optional):
object Amount(Discount)
Title:
Amount(Discount)
The discount amount for this line. -
displayedItemName_l(optional):
string
Title:
Item
Either the standard item name or the customer item name(if provided). -
firstRecurringInvoiceDate_l(optional):
string
Title:
First Recurring Invoice Date
Optional - Use if the first payment is for a prorated partial period. Regular recurrence will start from this date. -
fulfillmentStatus_l(optional):
object Fulfillment Status
Title:
Fulfillment Status
The status for this line supplied by the fulfillment system after the transaction is submitted as a sales order. -
itemInstanceId_l(optional):
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(optional):
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(optional):
string
Title:
Last Updated By
The person that last updated this transaction line. -
lastUpdatedDate_l(optional):
string
Title:
Last Updated
The date and time the transaction line was last updated. -
lineID_l(optional):
string
Title:
Line ID
The unique, invariant, internal ID for a Transaction Line. This value remains static even if the user resequences the lines on a transaction. This ID is used for identifying the line being canceled. The value for this attribute defaults to the _document_number for this transaction line. -
lineNumber_l(optional):
string
Title:
Line #
The line number displayed for the line. This is used to sort lines on the screen and in documents. -
listAmount_l(optional):
object Amount (List)
Title:
Amount (List)
The extended list amount for this line. -
listPrice_l(optional):
object Price (List)
Title:
Price (List)
The list price of the item. -
netAmount_l(optional):
object Amount (Net)
Title:
Amount (Net)
The extended list amount minus any discounts for this line. -
netPrice_l(optional):
object Price (Net)
Title:
Price (Net)
The price paid by the customer for the item. -
parentLineID_l(optional):
string
Title:
Parent Line ID
The unique, invariant, internal ID for the Parent Line for this Transaction Line. This is used for configured products for which child lines are associated to a parent model line. The value for this attribute remains static even if the user resequences the lines within a model. The value for this attribute defaults to the system attribute _parent_doc_number - the internal document number for the parent transaction line. -
parentLineNumber_l(optional):
string
Title:
Parent Line #
The line number that is the immediate parent of this line in the configurable product sales BOM hierarchy. This is the line number displayed to the user in the UI rather than the ID for the Parent Line. -
pricePeriod_l(optional):
object Period
Title:
Period
The period of service purchased at this price. -
priceType_l(optional):
object Price Type
Title:
Price Type
Indicates whether the amount on this line is charged once or periodically. -
priceWithinPolicy_l(optional):
boolean
Title:
Price Within Policy
Flag which indicates if line price is within requesting user's defined pricing limits -
requestDate_l(optional):
string
Title:
Request Date
The date on which the user requests that fulfillment occur for this transaction line. -
requestedQuantity_l(optional):
integer
Title:
Quantity
Quantity of associated line which is being requested. Can be user entered or set logically -
requestedUnitOfMeasure_l(optional):
object Unit of Measure
Title:
Unit of Measure
The unit of measure of the item requested by the customer (e.g. "Cases"). -
status_l(optional):
object Status
Title:
Status
The status of this line. -
statusDate_l(optional):
string
Title:
Status As Of
Date and time when the fulfillment status changed to its current status. -
statusPartial_l(optional):
boolean
Title:
Partial
Indicates whether the entire line has reached the current status. -
statusQuantity_l(optional):
integer
Title:
Status Quantity
The quantity of items that have reached the current status. -
taxExempt_l(optional):
boolean
Title:
Tax Exempt
Indicates whether this transaction line is tax exempt. -
taxExemptReason_l(optional):
object Tax Exempt Reason
Title:
Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults from the value on the transaction. -
transactionID_l(optional):
string
Title:
Transaction Internal ID
The parent transaction's internal ID. -
unitCost_l(optional):
object Unit Cost
Title:
Unit Cost
The unit cost of the item.
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 : excludeFieldTypes
Type:
array
Array of field names that you want to exclude in the response.
Show Source
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 : groups
Type:
array
Array of group names, whose state is requested in the state object response.
Show Source
Nested Schema : nodesExceptionList
Type:
array
Array of document_number, recording the nodes that violate current expandNodes flag
Show Source
Nested Schema : orderBy
Type:
array
Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
Show Source
Nested Schema : Child query criteria.
Type:
object
Title:
Child query criteria.
Captures the query criteria for the child resource.
Show Source
-
name(optional):
string
Rest alias name of the child resource this query belongs to.
-
queryDef(optional):
object Query Definition
Title:
Query Definition
Captures the query definition for the current resource request. -
recursive(optional):
boolean
Boolean value that specifies whether this query is a recursive expand on the current child resource query.
Nested Schema : Model Base Price
Type:
object
Title:
Model Base Price
Base price of the model
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the base price. -
value(optional):
number
Title:
value
Amount value for the base price.
Nested Schema : Part Base Price
Type:
object
Title:
Part Base Price
Price of the part
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the part base price. -
value(optional):
number
Title:
value
Amount value for the part base price.
Nested Schema : Configurable Price
Type:
object
Title:
Configurable Price
Original price as per catalog (inclusive of discount and premium)
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the configurable price. -
value(optional):
number
Title:
value
Amount value of the configurable price.
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(optional):
string
Title:
currency
Currency code of the item price. -
value(optional):
number
Title:
value
Amount value of the item price.
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(optional):
string
Title:
currency
Currency code of the list price. -
value(optional):
number
Title:
value
Amount value of the list price.
Nested Schema : Net Price
Type:
object
Title:
Net Price
Net price is subtotal minus the total discount
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the net price. -
value(optional):
number
Title:
value
Amount value of the net price.
Nested Schema : Override Discount
Type:
object
Title:
Override Discount
Override original discount
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the override original discount. -
value(optional):
string
Title:
value
Value of the override original discount.
Nested Schema : Override Price
Type:
object
Title:
Override Price
Override original list price
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the override price. -
value(optional):
string
Title:
value
Value of the override price.
Nested Schema : Total Discount
Type:
object
Title:
Total Discount
Total discount amount
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the total discount. -
value(optional):
number
Title:
value
Amount value of the total discount.
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(optional):
string
Title:
currency
Currency code of the unit price. -
value(optional):
number
Title:
value
Amount value of the unit price.
Nested Schema : Pricing Rule Price
Type:
object
Title:
Pricing Rule Price
Currently the customer level pricing. (Not applicable for Models)
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the customer level price. -
value(optional):
number
Title:
value
Amount value for the customer level price.
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(optional):
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(optional):
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(optional):
boolean
Title:
Deletable
Boolean value that specifies whether the row can be deleted. -
groups(optional):
object Groups
Title:
Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group. -
hasError(optional):
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning(optional):
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden(optional): boolean
-
messages(optional):
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
updatable(optional):
boolean
Title:
Updatable
Boolean value that specifies whether the row can be updated.
Nested Schema : Actual Amount
Type:
object
Title:
Actual Amount
The actual amount billed to the customer.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the actual amount. -
value(optional):
number
Title:
value
Amount value of the actual amount.
Nested Schema : Annual Discount
Type:
object
Title:
Annual Discount
The annual discount on the recurring charges on this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the annual discount. -
value(optional):
number
Title:
value
Amount value of the annual discount.
Nested Schema : Annual Value
Type:
object
Title:
Annual Value
The annual contract value of the recurring charges on this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the annual value. -
value(optional):
number
Title:
value
Amount value of the annual value.
Nested Schema : Cancel Reason
Type:
object
Title:
Cancel Reason
The reason why the customer cancelled this line.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the reason for cancelling this line. -
value(optional):
string
Title:
value
Value of the reason for cancelling this line.
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(optional):
string
Title:
currency
Currency code of the contract discount of this line. -
value(optional):
number
Title:
value
Amount value of the contract discount of this line.
Nested Schema : Contract Value
Type:
object
Title:
Contract Value
The total contract value of this line including all one - time and recurring charges.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the contract value of this line. -
value(optional):
number
Title:
value
Amount value for the contract value of this line..
Nested Schema : Cost Amount
Type:
object
Title:
Cost Amount
The total cost of this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the cost amount. -
value(optional):
number
Title:
value
Amount value of the cost amount.
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(optional):
string
Title:
currency
Currency code of the discount amount. -
value(optional):
number
Title:
value
Amount value of the discount amount.
Nested Schema : Discount Type
Type:
object
Title:
Discount Type
The type of custom discount to apply to this line.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value for the type of custom discount to apply to this line. -
value(optional):
string
Title:
value
Value for the type of custom discount to apply to this line.
Nested Schema : Amount(Discount)
Type:
object
Title:
Amount(Discount)
The discount amount for this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the discount amount for this line. -
value(optional):
number
Title:
value
Amount value of the discount amount for this line.
Nested Schema : Fulfillment Status
Type:
object
Title:
Fulfillment Status
The status for this line supplied by the fulfillment system after the transaction is submitted as a sales order.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the Value of the fulfillment status. -
value(optional):
string
Title:
value
Value of the fulfillment status for this line.
Nested Schema : Amount (List)
Type:
object
Title:
Amount (List)
The extended list amount for this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the list amount for this line. -
value(optional):
number
Title:
value
Amount value of the list amount for this line.
Nested Schema : Price (List)
Type:
object
Title:
Price (List)
The list price of the item.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the list price of the item. -
value(optional):
number
Title:
value
Amount value of the list price of the item.
Nested Schema : Amount (Net)
Type:
object
Title:
Amount (Net)
The extended list amount minus any discounts for this line.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the net amount for this line. -
value(optional):
number
Title:
value
Amount value of the net amount for this line.
Nested Schema : Price (Net)
Type:
object
Title:
Price (Net)
The price paid by the customer for the item.
Show Source
-
currency(optional):
string
Title:
currency
Currency code of the net price for the item. -
value(optional):
number
Title:
value
Amount value of the net price for the item.
Nested Schema : Period
Type:
object
Title:
Period
The period of service purchased at this price.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the period of service. -
value(optional):
string
Title:
value
Value of the period of service.
Nested Schema : Price Type
Type:
object
Title:
Price Type
Indicates whether the amount on this line is charged once or periodically.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the price type. -
value(optional):
string
Title:
value
Value of the price type.
Nested Schema : Unit of Measure
Type:
object
Title:
Unit of Measure
The unit of measure of the item requested by the customer (e.g. "Cases").
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the unit of measure. -
value(optional):
string
Title:
value
Value of the unit of measure.
Nested Schema : Status
Type:
object
Title:
Status
The status of this line.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the status of this line. -
value(optional):
string
Title:
value
Value of the status of this line.
Nested Schema : Tax Exempt Reason
Type:
object
Title:
Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults from the value on the transaction.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the reason for tax exemption. -
value(optional):
string
Title:
value
Value of the reason for tax exemption.
Nested Schema : Unit Cost
Type:
object
Title:
Unit Cost
The unit cost of the item.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the unit cost of the item. -
value(optional):
number
Title:
value
Amount value for the unit cost of the item.
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 : Groups
Type:
object
Title:
Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
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
Default Response
Root Schema : commerceTransaction-ModifyResponse
Type:
Show Source
object
-
cacheInstanceId(optional):
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. -
destinationURL(optional):
string
Title:
Destination URL
The destination url as defined in destination tab in action definition. -
documents(optional):
object commerceTransaction
-
warnings(optional):
array Warnings
Title:
Warnings
Array of warnings that have been generated for a specific object.
Nested Schema : commerceTransaction
Type:
Show Source
object
-
_buyer_company_name(optional):
string
Title:
Buyer Company Name
The name of the buyer company. -
_currency_pref(optional):
object
Title:
-
_customer_id(optional):
string
Title:
Customer Id
This is the special Customer ID (with attribute type = Customer ID) used in CPQ-platform-supplied CRM integrations. This attribute is associated with the automatically-created Autofill, Browse, Select Alternate Address, and View Actions. -
_customer_t_address(optional):
string
Title:
Customer Address
Address of the customer. -
_customer_t_address_2(optional):
string
Title:
Customer Address
Address of the customer. -
_customer_t_city(optional):
string
Title:
Customer City
Name of the city associated with the customer address. -
_customer_t_company_name(optional):
string
Title:
Customer Company Name
Company name of the customer. -
_customer_t_company_name_2(optional):
string
Title:
Customer Company Name 2
Address of the customer. -
_customer_t_country(optional):
object Customer Country
Title:
Customer Country
Name of the country associated with the customer address. -
_customer_t_email(optional):
string
Title:
Customer Email
Email address of the customer. -
_customer_t_fax(optional):
string
Title:
Customer Fax
Fax number of the customer. -
_customer_t_first_name(optional):
string
Title:
Customer First Name
First name of the customer. -
_customer_t_last_name(optional):
string
Title:
Customer Last Name
Last name of the customer. -
_customer_t_phone(optional):
string
Title:
Customer Phone
Phone number of the customer. -
_customer_t_state(optional):
object Customer State
Title:
Customer State
Name of the state associated with the customer address. -
_customer_t_zip(optional):
string
Title:
Customer Zip
Zip code associated with the customer address. -
_date_added(optional):
string
Title:
Date Added
The date when the transaction record got added. -
_date_modified(optional):
string
Title:
Date Last Modified
The date when the transaction record got modified. -
_document_number(optional):
string
Title:
Document Number
Unique doc number to be used as document identifier in a process -
_document_var_name(optional):
string
Title:
Document Variable Name
This is the document variable name. A document can either be a 'Main Document' or 'SubDocument - Transaction Line'. Variable name for the main document is 'transaction' and for the sub document, it is 'transactionLine'. Main (Header Level) Commerce Document serves as Quote/Order depending on step in process flow. -
_eSignatureAttributeSet_esig_date_modified(optional):
string
Title:
eSignature Date Modified[eSignature Attribute Set]
The Date Modified field contains the date of the most recently performed action on this document -
_eSignatureAttributeSet_esig_envelope_id(optional):
string
Title:
eSignature Envelope ID[eSignature Attribute Set]
The Envelope ID is a hidden field that is sent along with the document to the eSignature Vendor -
_eSignatureAttributeSet_esig_file_attachment(optional):
object eSignature File Attachment[eSignature Attribute Set]
Title:
eSignature File Attachment[eSignature Attribute Set]
The File Attachment attribute holds the documents to be sent to the eSignature Vendor -
_eSignatureAttributeSet_esig_recipients(optional):
string
Title:
eSignature Recipients[eSignature Attribute Set]
The Recipients holds the emails and names of the intended recipients -
_eSignatureAttributeSet_esig_status(optional):
object eSignature Status (eSignature Attribute Set)
Title:
eSignature Status (eSignature Attribute Set)
The Status field contains the current status of this document -
_id(optional):
integer
Title:
Id
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site. -
_invoiceTo_t_address(optional):
string
Title:
Invoice To Address
Address on the invoice. -
_invoiceTo_t_address_2(optional):
string
Title:
Invoice To Address 2
Address on the invoice. -
_invoiceTo_t_city(optional):
string
Title:
Invoice To City
Name of the city on the invoice address. -
_invoiceTo_t_company_name(optional):
string
Title:
Invoice To Company Name
Company name on the invoice. -
_invoiceTo_t_company_name_2(optional):
string
Title:
Invoice To Company Name 2
Company name on the invoice. -
_invoiceTo_t_country(optional):
object Invoice To Country
Title:
Invoice To Country
Name of the country on the invoice address. -
_invoiceTo_t_email(optional):
string
Title:
Invoice To Email
Email address on the invoice. -
_invoiceTo_t_fax(optional):
string
Title:
Invoice To Fax
Fax number on the invoice. -
_invoiceTo_t_first_name(optional):
string
Title:
Invoice To First Name
First name on the invoice. -
_invoiceTo_t_last_name(optional):
string
Title:
Invoice To Last Name
Last name on the invoice. -
_invoiceTo_t_phone(optional):
string
Title:
Invoice To Phone
Phone number on the invoice. -
_invoiceTo_t_state(optional):
object Invoice To State
Title:
Invoice To State
Name of the state on the invoice address. -
_invoiceTo_t_zip(optional):
string
Title:
Invoice To Zip
Zip code on the invoice address. -
_last_document_number(optional):
integer
Title:
Last Document Number
Unique document identifier of the last document in the transaction. -
_price_book_var_name(optional):
string
Title:
Price Book Variable Name
Variable Name of the Price Book used to get the price for this line item -
_process_var_name(optional):
string
Title:
Commerce Process Name
The process variable name of the commerce process. For the reference commerce process, the process variable name is oraclecpqo. -
_shipTo_t_address(optional):
string
Title:
Ship To Address
Address associated with the shipping address. -
_shipTo_t_address_2(optional):
string
Title:
Ship To Address 2
Address associated with the shipping address. -
_shipTo_t_city(optional):
string
Title:
Ship To City
Name of the city associated with the shipping address. -
_shipTo_t_company_name(optional):
string
Title:
Ship To Company Name
Company name associated with the shipping address. -
_shipTo_t_company_name_2(optional):
string
Title:
Ship To Company Name 2
Company name associated with the shipping address. -
_shipTo_t_country(optional):
object Ship To Country
Title:
Ship To Country
Name of the country associated with the shipping address. -
_shipTo_t_email(optional):
string
Title:
Ship To Email
Email address associated with the shipping address. -
_shipTo_t_fax(optional):
string
Title:
Invoice To Fax
Fax number on the invoice. -
_shipTo_t_first_name(optional):
string
Title:
Ship To First Name
First name associated with the shipping address. -
_shipTo_t_last_name(optional):
string
Title:
Ship To Last Name
Last name associated with the shipping address. -
_shipTo_t_phone(optional):
string
Title:
Ship To Phone
Phone number associated with the shipping address. -
_shipTo_t_state(optional):
object Ship To State
Title:
Ship To State
Name of the state associated with the shipping address. -
_shipTo_t_zip(optional):
string
Title:
Ship To Zip
Zip code associated with the shipping address. -
_soldTo_t_address(optional):
string
Title:
Ship To Address
Address associated with the shipping address. -
_soldTo_t_address_2(optional):
string
Title:
Sold To Address 2
Address associated with the Sold To party. -
_soldTo_t_city(optional):
string
Title:
Sold To City
Name of the city associated with the Sold To party. -
_soldTo_t_company_name(optional):
string
Title:
Sold To Company Name
Company name associated with the Sold To party. -
_soldTo_t_company_name_2(optional):
string
Title:
Sold To Company Name 2
Company name associated with the Sold To party. -
_soldTo_t_country(optional):
object Sold To Country
Title:
Sold To Country
Name of the country associated with the Sold To party. -
_soldTo_t_email(optional):
string
Title:
Sold To Email
Email address associated with the Sold To party. -
_soldTo_t_fax(optional):
string
Title:
Invoice To Fax
Fax number on the invoice. -
_soldTo_t_first_name(optional):
string
Title:
Sold To First Name
First name associated with the Sold To party. -
_soldTo_t_last_name(optional):
string
Title:
Sold To Last Name
Last name associated with the Sold To party. -
_soldTo_t_phone(optional):
string
Title:
Sold To Phone
Phone number associated with the Sold To party. -
_soldTo_t_state(optional):
object Sold To State
Title:
Sold To State
Name of the state associated with the Sold To party. -
_soldTo_t_zip(optional):
string
Title:
Sold To State
Name of the state associated with the Sold To party. -
_state(optional):
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(optional):
string
Title:
Current Step Variable Name
This is the variable name of the transaction's current commerce process step. For example, for 'Start' step, the step variable name is 'start_step'. -
_submitted_by_submit_t(optional):
string
Title:
Submitted By[Submit]
Login of Submitter. Only populated after corresponding submit action is performed. -
_supplier_company_name(optional):
string
Title:
Supplier Company Name
The name of the supplier company. -
_transaction_total(optional):
object Transaction Total
Title:
Transaction Total
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value. -
approval_history_submit_t(optional):
string
Title:
Approval History[Submit]
This attribute records approval history of a transaction. If a reason is reset, it is erased from the approval history. -
approval_revision_submit_t(optional):
integer
Title:
Approval Revision[Submit]
This attribute tracks the number of times a quote has been revised -
approval_status_submit_t(optional):
string
Title:
Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction. -
approve_reject_icon_submit_t(optional):
object My Approval[Submit]
Title:
My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input. -
bs_id(optional):
string
Title:
Transaction Internal ID
Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. -
cancelReason_t(optional):
object Cancel Reason
Title:
Cancel Reason
The reason expressed by the customer for canceling this order. -
coverLetter_t(optional):
string
Title:
Cover Letter
The cover letter to be attached to the proposal document for this transaction. -
createdBy_t(optional):
string
Title:
Created By
The person that created the transaction. -
createdDate_t(optional):
string
Title:
Created Date
The date when the transaction was created. -
currency_t(optional):
object Currency
Title:
Currency
The currency used to price and invoice this transaction. -
currentStepForTesting_tempDisplay_t(optional):
string
Title:
Current Step
This attribute is exposed only to the Administrator to assist in debugging modifications to the Commerce Process Steps and Transition Rules. -
customerID_t(optional):
string
Title:
Customer ID
The Customer ID to be used in package and custom integrations other than the CPQ-platform-supplied CRM integrations. In BASE Commerce Process this attribute defaults to the value for the CPQ-platform-supplied integration attribute _customer_id. -
customerPartyID_t(optional):
string
Title:
Customer Party ID
The Party ID for the CRM Customer. This attribute is used when a generalized Party object is used to identify customer parties in addition to the Customer ID. -
customerPartySiteID_t(optional):
string
Title:
Customer Party Site ID
The ID for the Party Site or Address of the CRM Customer. -
defaultRequestDate_t(optional):
string
Title:
Default Request Date
The date on which the user requests that fulfillment occur for this transaction. -
fulfillmentStatus_t(optional):
object Fulfillment Status
Title:
Fulfillment Status
This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order. -
hasRecurringPricing_t(optional):
boolean
Title:
Has Recurring Pricing
Indicates whether this transaction uses recurring pricing. This is used to hide the recurrence period column in the line item grid. -
invoiceToPartyID_t(optional):
string
Title:
Invoice To Party ID
The Party ID for the Invoice To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer and Sold To Parties. -
invoiceToPartySiteID_t(optional):
string
Title:
Invoice To Party Site ID
The ID for the Party Site or Address of the Invoice To party. -
lastPricedDate_t(optional):
string
Title:
Last Priced
The date and time that this transaction was last re-priced. -
lastUpdatedBy_t(optional):
string
Title:
Last Updated By
The person that last updated this transaction. -
lastUpdatedDate_t(optional):
string
Title:
Last Updated
The date and time the transaction was last updated. -
opportunityID_t(optional):
string
Title:
Opportunity ID
The identifier of the parent opportunity. -
opportunityName_t(optional):
string
Title:
Opportunity
The name of the parent opportunity. -
opportunityNumber_t(optional):
string
Title:
Opportunity Number
The user or public identifier for the opportunity associated to this transaction. -
orderDate_t(optional):
string
Title:
Order Date
The date and time the order was placed for fulfillment. -
orderPlacedBy_t(optional):
string
Title:
Ordered By
Records the Current User when the Create Order Action is triggered -
owner_t(optional):
string
Title:
Owner
The person that owns this transaction. -
parent_transaction_id_versionTransaction_t(optional):
string
Title:
Parent Transaction Id[Version Transaction]
This Attribute contains the parent transaction id. -
paymentTerms_t(optional):
object Payment Terms
Title:
Payment Terms
The payment terms the customer will receive on their invoice. -
priceExpirationDate_t(optional):
string
Title:
Price Expiration Date
The date the price quote will expire. -
priceWithinPolicy_t(optional):
boolean
Title:
Price Within Policy
Indicates whether the prices in this transaction are all within their discount authority. -
proposalPreparedByCell_t(optional):
string
Title:
Proposal Prepared By Cell
The cell phone number of the person who prepared the proposal attached to this transaction. -
proposalPreparedByEmail_t(optional):
string
Title:
Proposal Prepared By Email
The email address of the person who prepared the proposal attached to this transaction. -
proposalPreparedByName_t(optional):
string
Title:
Proposal Prepared By Name
The name of the person who prepared the proposal attached to this transaction. -
proposalPreparedByPhone_t(optional):
string
Title:
Proposal Prepared By Phone
The phone number of the person who prepared the proposal attached to this transaction. -
proposalPreparedByTitle_t(optional):
string
Title:
Proposal Prepared By Title
The title of the person who prepared the proposal attached to this transaction. -
purchaseOrderNumber_t(optional):
string
Title:
PO Number
The purchase order number provided by the customer. -
refApReleaseDate(optional):
string
Title:
Reference Application Release Date
The date/time on which this version of the Base Reference Application was released. -
rejectExplanation_t(optional):
string
Title:
Reject Explanation
A detailed explanation of why the customer rejected the deal. -
rejectReason_t(optional):
object Reject Reason
Title:
Reject Reason
The reason expressed by customer for rejecting this deal. -
requireApprovalIfChecked_temporary_t(optional):
boolean
Title:
Require Approval If Checked
This attribute is exposed only to the Administrator to assist in debugging of approval flows. Checking and unchecking the attribute allows the Administrator to more easily test flows requiring or not requiring approvals. -
salesChannel_t(optional):
object Sales Channel
Title:
Sales Channel
The channel that originated the transaction. -
shipToPartyID_t(optional):
string
Title:
Ship To Party ID
The Party ID for the Ship To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer, Sold To, and Invoice To Parties. -
shipToPartySiteID_t(optional):
string
Title:
Ship To Party Site ID
The ID for the Party Site or Address of the Ship To party. -
soldToPartyID_t(optional):
string
Title:
Sold To Party ID
The Party ID for the Sold To Party / ERP Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Sold To Party / ERP Customer may differ from the CRM Customer Party. -
soldToPartySiteID_t(optional):
string
Title:
Sold To Party Site ID
The ID for the Party Site or Address of the Sold To party. -
status_t(optional):
object Status
Title:
Status
The most advanced milestone reached by lines of this transaction. -
statusDate_t(optional):
string
Title:
Status As Of
Date and time when the fulfillment status changed to its current status. -
statusPartial_t(optional):
boolean
Title:
Partial
Indicates whether all lines have reached the most advanced milestone. -
taxExempt_t(optional):
boolean
Title:
Tax Exempt
Flag indicating if the Transaction is tax-exempt -
taxExemptReason_t(optional):
object Tax Exempt Reason
Title:
Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults to the line items where it can be overridden. -
TotalAnnualDiscount_t(optional):
object Annual Contract Discount
Title:
Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction. -
totalAnnualValue_t(optional):
object Annual Contract Value
Title:
Annual Contract Value
The total value of recurring charges each year. -
totalContractDiscount_t(optional):
object Total Contract Discount
Title:
Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract. -
totalContractValue_t(optional):
object Total Contract Value
Title:
Total Contract Value
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. -
totalMonthlyDiscount_t(optional):
object Total Discount Per Month
Title:
Total Discount Per Month
The total of discounts off monthly recurring charges. -
totalMonthlyListAmount_t(optional):
object Total (List) Per Month
Title:
Total (List) Per Month
The total of all monthly list amounts on the lines. -
totalMonthlyNetAmount_t(optional):
object Total (Net) Per Month
Title:
Total (Net) Per Month
The total of all monthly net amounts on the lines. -
totalOneTimeDiscount_t(optional):
object Total Discount
Title:
Total Discount
The total of all extended discount amounts for one time pricing/charges. -
totalOneTimeListAmount_t(optional):
object Total (List)
Title:
Total (List)
The total of all one-time charges on the lines. -
totalOneTimeNetAmount_t(optional):
object Total (Net)
Title:
Total (Net)
The total one time net charge. -
transactionDescription_t(optional):
string
Title:
Transaction Description
Description of the CPQ Transaction. -
transactionID_t(optional):
string
Title:
Transaction Number
The number or public unique identifier of the transaction. -
transactionName_t(optional):
string
Title:
Transaction Name
Attribute which captures the user entered Transaction Name -
userKey_t(optional):
string
Title:
Number
The transaction ID and version number concatenated together to make a single user key value or Number that uniquely identifies this transaction version. -
version_number_versionTransaction_t(optional):
string
Title:
Version Number
This Attribute Lists the Version Number for a document. -
version_t(optional):
integer
Title:
Version
The transaction ID combined with the version number are the unique key for the document. When a transaction is versioned this number is incremented. This is the Commerce Process-defined Version that defaults to the CPQ-Platform-created Version Number (version_number_versionTransaction).
Nested Schema : Warnings
Type:
array
Title:
Warnings
Array of warnings that have been generated for a specific object.
Show Source
-
Array of:
string
A warning or informational message.
Nested Schema :
Type:
object
Title:
Show Source
-
currencyCode(optional):
string
Title:
Currency Code
Unique currency code for the currency. -
id(optional):
integer
Title:
Id
Primary Key of the currency resource.
Nested Schema : Customer Country
Type:
object
Title:
Customer Country
Name of the country associated with the customer address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for customer country -
value(optional):
string
Title:
value
The customer country name
Nested Schema : Customer State
Type:
object
Title:
Customer State
Name of the state associated with the customer address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for customer state -
value(optional):
string
Title:
value
The customer state value
Nested Schema : eSignature File Attachment[eSignature Attribute Set]
Type:
object
Title:
eSignature File Attachment[eSignature Attribute Set]
The File Attachment attribute holds the documents to be sent to the eSignature Vendor
Nested Schema : eSignature Status (eSignature Attribute Set)
Type:
object
Title:
eSignature Status (eSignature Attribute Set)
The Status field contains the current status of this document
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the eSignature status. -
value(optional):
string
Title:
value
Value of the eSignature status.
Nested Schema : Invoice To Country
Type:
object
Title:
Invoice To Country
Name of the country on the invoice address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for invoice country -
value(optional):
string
Title:
value
The invoice country value
Nested Schema : Invoice To State
Type:
object
Title:
Invoice To State
Name of the state on the invoice address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for invoice state -
value(optional):
string
Title:
value
The invoice state value
Nested Schema : Ship To Country
Type:
object
Title:
Ship To Country
Name of the country associated with the shipping address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for Country -
value(optional):
string
Title:
value
The country value
Nested Schema : Ship To State
Type:
object
Title:
Ship To State
Name of the state associated with the shipping address.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for ship to state -
value(optional):
string
Title:
value
The ship to state value
Nested Schema : Sold To Country
Type:
object
Title:
Sold To Country
Name of the country associated with the Sold To party.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for the sold to sountry -
value(optional):
string
Title:
value
The sold to sountry value
Nested Schema : Sold To State
Type:
object
Title:
Sold To State
Name of the state associated with the Sold To party.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for sold to state -
value(optional):
string
Title:
value
The sold to state 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(optional):
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(optional):
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(optional):
boolean
Title:
Deletable
Boolean value that specifies whether the row can be deleted. -
groups(optional):
object Groups
Title:
Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group. -
hasError(optional):
boolean
Title:
Has Error
Boolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning(optional):
boolean
Title:
Has Warning
Boolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden(optional): boolean
-
messages(optional):
array Messages
Title:
Messages
Array of messages that have been generated for a specific object. -
updatable(optional):
boolean
Title:
Updatable
Boolean value that specifies whether the row can be updated.
Nested Schema : Transaction Total
Type:
object
Title:
Transaction Total
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for transaction total -
value(optional):
number
Title:
value
The transaction total value
Nested Schema : My Approval[Submit]
Type:
object
Title:
My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Cancel Reason
Type:
object
Title:
Cancel Reason
The reason expressed by the customer for canceling this order.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the reason for canceling this deal. -
value(optional):
string
Title:
value
Value of the reason for canceling this deal.
Nested Schema : Currency
Type:
object
Title:
Currency
The currency used to price and invoice this transaction.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the currency. -
value(optional):
string
Title:
value
Value of the currency.
Nested Schema : Fulfillment Status
Type:
object
Title:
Fulfillment Status
This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Dislay value of the fulfillment status. -
value(optional):
string
Title:
value
Value of the fulfillment status.
Nested Schema : Payment Terms
Type:
object
Title:
Payment Terms
The payment terms the customer will receive on their invoice.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the payment term. -
value(optional):
string
Title:
value
Value of the payment term.
Nested Schema : Reject Reason
Type:
object
Title:
Reject Reason
The reason expressed by customer for rejecting this deal.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the reason for rejecting this deal. -
value(optional):
string
Title:
value
Value of the reason for rejecting this deal.
Nested Schema : Sales Channel
Type:
object
Title:
Sales Channel
The channel that originated the transaction.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the sales channel. -
value(optional):
string
Title:
value
Value of the sales channel.
Nested Schema : Status
Type:
object
Title:
Status
The most advanced milestone reached by lines of this transaction.
Show Source
-
displayValue(optional):
string
Title:
displayValue
Display value of the status. -
value(optional):
string
Title:
value
Value of the status.
Nested Schema : Tax Exempt Reason
Type:
object
Title:
Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults to the line items where it can be overridden.
Show Source
-
displayValue(optional):
string
Title:
displayValue
The display value for the tax exempt reason -
value(optional):
string
Title:
value
The tax exempt reason value
Nested Schema : Annual Contract Discount
Type:
object
Title:
Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total annual discount. -
value(optional):
number
Title:
value
Amount value for the total annual discount.
Nested Schema : Annual Contract Value
Type:
object
Title:
Annual Contract Value
The total value of recurring charges each year.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total annual value. -
value(optional):
number
Title:
value
Amount value for the total annual value.
Nested Schema : Total Contract Discount
Type:
object
Title:
Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total contract discount. -
value(optional):
number
Title:
value
Amount value for the total contract discount.
Nested Schema : Total Contract Value
Type:
object
Title:
Total Contract Value
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total contract value. -
value(optional):
number
Title:
value
Amount value for the total contract value.
Nested Schema : Total Discount Per Month
Type:
object
Title:
Total Discount Per Month
The total of discounts off monthly recurring charges.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total monthly discount. -
value(optional):
number
Title:
value
Amount value for the total monthly discount.
Nested Schema : Total (List) Per Month
Type:
object
Title:
Total (List) Per Month
The total of all monthly list amounts on the lines.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total monthly list amount. -
value(optional):
number
Title:
value
Amount value for the total monthly list amount.
Nested Schema : Total (Net) Per Month
Type:
object
Title:
Total (Net) Per Month
The total of all monthly net amounts on the lines.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total monthly net amount. -
value(optional):
number
Title:
value
Amount value for the total monthly net amount.
Nested Schema : Total Discount
Type:
object
Title:
Total Discount
The total of all extended discount amounts for one time pricing/charges.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total one time discount. -
value(optional):
number
Title:
value
Amount value for the total one time discount.
Nested Schema : Total (List)
Type:
object
Title:
Total (List)
The total of all one-time charges on the lines.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total one time list amount. -
value(optional):
number
Title:
value
Amount value for the total one time list amount.
Nested Schema : Total (Net)
Type:
object
Title:
Total (Net)
The total one time net charge.
Show Source
-
currency(optional):
string
Title:
currency
Currency code for the total one time net amount. -
value(optional):
number
Title:
value
Amount value for the total one time net amount.
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 : Groups
Type:
object
Title:
Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
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.