Submit - Revise Transaction
post
/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/revise_submit_t
Use this endpoint to revise the transaction submitted for approval.
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.
-
id(required): integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Root Schema : Transaction-ReviseRequest
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
Title:
Transaction
-
reason_var_name:
string
Title:
Reason Variable Name
While requesting approval, performer is supposed to choose reason preconfigured in approval workflow for seeking approval -
revisionId:
string
Title:
Revision Id
The string parameter that contains the revision information. -
selectionMode:
string
Title:
Selection Mode
Indicating how selections content should be interpreted, supported values are: 1) ' ' - content of ' selections ' param OR 2) ' ResultSetExceptSelected ' - all entries in result set except those listed in ' selections ' param -
selections:
array selections
-
skipIntegration:
boolean
Title:
skipIntegration
If value for ' skipIntegration ' is true, integration tab logic is skipped, otherwise(value is false or absent) it is executed.
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
Type:
object
Title:
Show Source
Transaction
-
_approve_link:
string
Title:
Approve Link
Links to auto-generate approve response. This is only populated in advanced notification email rules. -
_buyer_company_name:
string
Title:
_buyer_company_name
-
_currency_pref:
object _currency_pref
Title:
_currency_pref
-
_customer_id:
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:
string
Title:
Customer Address
First Line for the Address of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_address_2:
string
Title:
Customer Address 2
Second Line for the Address of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_city:
string
Title:
Customer City
City of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_company_name:
string
Title:
Customer Company Name
Company Name of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_company_name_2:
string
Title:
Customer Company Name 2
Secondary Company Name of the buying organization for this transation linked from the CRM System.This is functionally eqivalent to the Sold To company. -
_customer_t_country:
object Customer Country
Title:
Customer Country
-
_customer_t_email:
string
Title:
Customer Email
Email Address of the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_fax:
string
Title:
Customer Fax
Fax Number for the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_first_name:
string
Title:
Customer First Name
First Name of the contact person for the buying organization linked from the CRM System.This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_last_name:
string
Title:
Customer Last Name
Last Name of the contact person for the buying organization linked from the CRM System.This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_phone:
string
Title:
Customer Phone
Phone Number for the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_state:
object Customer State
Title:
Customer State
-
_customer_t_zip:
string
Title:
Customer Zip
Zip Code of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_date_added:
string
Title:
_date_added
-
_date_modified:
string
Title:
_date_modified
-
_date_tx_modified:
string
Title:
_date_tx_modified
-
_document_number:
string
Title:
Document Number
Unique doc number to be used as document identifier in a process -
_document_var_name:
string
Title:
_document_var_name
-
_eSignatureAttributeSet_esig_date_modified:
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:
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:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
_eSignatureAttributeSet_esig_recipients:
string
Title:
eSignature Recipients[eSignature Attribute Set]
The Recipients holds the emails and names of the intended recipients -
_eSignatureAttributeSet_esig_status:
object eSignature Status[eSignature Attribute Set]
Title:
eSignature Status[eSignature Attribute Set]
-
_esigTest_c_esig_date_modified:
string
Title:
eSignature Date Modified[esig Test]
The Date Modified field contains the date of the most recently performed action on this document -
_esigTest_c_esig_envelope_id:
string
Title:
eSignature Envelope ID[esig Test]
The Envelope ID is a hidden field that is sent along with the document to the eSignature Vendor -
_esigTest_c_esig_file_attachment:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
_esigTest_c_esig_recipients:
string
Title:
eSignature Recipients[esig Test]
The Recipients holds the emails and names of the intended recipients -
_esigTest_c_esig_status:
object eSignature Status[esig Test]
Title:
eSignature Status[esig Test]
-
_id:
integer
Title:
_id
-
_invoiceTo_t_address:
string
Title:
Invoice To Address
First Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_address_2:
string
Title:
Invoice To Address 2
Second Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_city:
string
Title:
Invoice To City
City of the organization being billed for this transaction. -
_invoiceTo_t_company_name:
string
Title:
Invoice To Company Name
Company Name of the organization being billed for this transaction. -
_invoiceTo_t_company_name_2:
string
Title:
Invoice To Company Name 2
Secondary Company Name of the organization being billed for this transaction. -
_invoiceTo_t_country:
object Invoice To Country
Title:
Invoice To Country
-
_invoiceTo_t_email:
string
Title:
Invoice To Email
Email Address of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_fax:
string
Title:
Invoice To Fax
Fax Number for the contact person for the organization being billed for this transaction. -
_invoiceTo_t_first_name:
string
Title:
Invoice To First Name
First Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_last_name:
string
Title:
Invoice To Last Name
Last Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_phone:
string
Title:
Invoice To Phone
Phone Number for the contact person for the organization being billed for this transaction. -
_invoiceTo_t_state:
object Invoice To State
Title:
Invoice To State
-
_invoiceTo_t_zip:
string
Title:
Invoice To Zip
Zip Code of the organization being billed for this transaction. -
_last_document_number:
integer
Title:
_last_document_number
-
_lock_status:
boolean
Title:
_lock_status
-
_locked_by_user:
integer
Title:
_locked_by_user
-
_locked_by_user_first_name:
string
Title:
_locked_by_user_first_name
First name of User who locked the trasnaction -
_locked_by_user_last_name:
string
Title:
_locked_by_user_last_name
Last Name of User who locked the trasnaction -
_locked_by_user_login:
string
Title:
_locked_by_user_login
Login of User who locked the trasnaction -
_locked_time:
string
Title:
_locked_time
-
_partner_price_book_id:
string
Title:
Partner Price Book Id
Partner Price Book Id -
_pp_id:
integer
Title:
_pp_id
-
_pp_name:
string
Title:
_pp_name
-
_price_book_custom_field_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. -
_price_book_custom_fields:
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_book_desc:
string
Title:
Price Book Description
Price Book Description -
_price_book_name:
string
Title:
Price Book Name
Price Book Name -
_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 -
_process_var_name:
string
Title:
_process_var_name
-
_reject_link:
string
Title:
Reject Link
Links to auto-generate reject response. This is only populated in advanced notification email rules. -
_revenueCategory_t:
object Revenue Category
Title:
Revenue Category
-
_s_accountContactNumber_t:
string
Title:
Account Contact Number
Contact number of the account. -
_s_accountIntegrationResponse_t:
string
Title:
Account Integration Response
Holds the response of TCA account integration. -
_s_accountPartyId_t:
string
Title:
Account PartyId
The CDM integration provides the value for this field based on the Customer Company Name -
_s_accountPartyNumber_t:
string
Title:
Account Party Number
Identifier for the type of the account under the party. -
_s_assignedTo_t:
object Assigned To
Title:
Assigned To
-
_s_billTo_t_address:
string
Title:
Bill To Address
-
_s_billTo_t_address_2:
string
Title:
Bill To Address 2
-
_s_billTo_t_city:
string
Title:
Bill To City
-
_s_billTo_t_company_name:
string
Title:
Bill To Company Name
-
_s_billTo_t_company_name_2:
string
Title:
Bill To Company Name 2
-
_s_billTo_t_country:
object Bill To Country
Title:
Bill To Country
-
_s_billTo_t_email:
string
Title:
Bill To Email
-
_s_billTo_t_fax:
string
Title:
Bill To Fax
-
_s_billTo_t_first_name:
string
Title:
Bill To First Name
-
_s_billTo_t_last_name:
string
Title:
Bill To Last Name
-
_s_billTo_t_phone:
string
Title:
Bill To Phone
-
_s_billTo_t_state:
object Bill To State
Title:
Bill To State
-
_s_billTo_t_zip:
string
Title:
Bill To Zip
-
_s_billToCustomerAccountID_t:
string
Title:
Bill to Customer Account Id
TCA account integration provides value from BillingAccountId to this field based on Customer Id and Business Unit ID -
_s_billToCustomerAccountName_t:
string
Title:
Bill To Customer Account Name
TCA account integration provides value from BillingAccountName to this field based on Customer Id and Business Unit ID -
_s_contactNumber_t:
string
Title:
Contact Number
Contact number of the contact. -
_s_contactPartyNumber_t:
string
Title:
Contact Party Number
Identifier for the type of the contact under the party. -
_s_contractID_t:
string
Title:
Contract ID
The identifier of the CLM contract -
_s_contractTypeID_t:
string
Title:
Contract Type ID
The identifier for the CLM contract Type. -
_s_customerPartySiteID_t:
string
Title:
Customer Party Site ID
The ID for the Party Site or Address of the CRM Customer. -
_s_customerStatus_t:
object Customer Status
Title:
Customer Status
-
_s_customerVisibilityIdentifier_t:
object Customer Visibility Identifier
Title:
Customer Visibility Identifier
-
_s_hostCompanyFullName_t:
string
Title:
Host Company Full Name
Full company name of current user' s company. -
_s_invoiceToPartySiteID_t:
string
Title:
Invoice To Party Site ID
The ID for the Party Site or Address of the Invoice To party. -
_s_isPublished_t:
boolean
Title:
Is Published
Indicates whether this quote was published to customer. This flag is set to true when the quote is published for the first time. -
_s_shipToPartyID_t:
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. -
_s_shipToPartySiteID_t:
string
Title:
Ship To Party Site ID
The ID for the Party Site or Address of the Ship To party. -
_s_soldToCustomerAccountID_t:
string
Title:
Sold To Customer Account ID
The unique internal identifier for the Sold To Customer Account used for credit checking and collections. The Sold To Customer Account is typically mastered in an external ERP or Financials system and referenced when CPQ integrates sales orders to these systems. A Sold To Customer Account is typically associated to a Bill To address but may be associated with more than one. -
_s_soldToPartyID_t:
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. -
_s_soldToPartyName_t:
string
Title:
Sold To Party Name
TCA account integration provides value from PartyName to this field based on Customer Id and Business Unit ID -
_s_soldToPartySiteID_t:
string
Title:
Sold To Party Site ID
The ID for the Party Site or Address of the Sold To party. -
_s_subscriptionId_t:
string
Title:
Subscription ID
The identifier of the subscription contract. -
_s_transactionSource_t:
object Source Of Transaction
Title:
Source Of Transaction
-
_shipTo_t_address:
string
Title:
Ship To Address
First Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_address_2:
string
Title:
Ship To Address 2
Second Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_city:
string
Title:
Ship To City
City of the organization where this transaction will be shipped. -
_shipTo_t_company_name:
string
Title:
Ship To Company Name
Company Name of the organization where this transaction will be shipped. -
_shipTo_t_company_name_2:
string
Title:
Ship To Company Name 2
Secondary Company Name of the organization where this transaction will be shipped. -
_shipTo_t_country:
object Ship To Country
Title:
Ship To Country
-
_shipTo_t_email:
string
Title:
Ship To Email
Email Address for the contact person for the organization to which this order will be shipped. -
_shipTo_t_fax:
string
Title:
Ship To Fax
Fax Number for the contact person for the organization to which this order will be shipped. -
_shipTo_t_first_name:
string
Title:
Ship To First Name
First Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_last_name:
string
Title:
Ship To Last Name
Last Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_phone:
string
Title:
Ship To Phone
Phone Number for the contact person for the organization to which this order will be shipped. -
_shipTo_t_state:
object Ship To State
Title:
Ship To State
-
_shipTo_t_zip:
string
Title:
Ship To Zip
Zip Code of the organization where this transaction will be shipped. -
_soldTo_t_address:
string
Title:
Sold To Address
First Line of the Address of the buying organization for this transation linked from the ERP System.This is functionally eqivalent to the Customer contact information. -
_soldTo_t_address_2:
string
Title:
Sold To Address 2
Second Line of the Address of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_city:
string
Title:
Sold To City
City of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_company_name:
string
Title:
Sold To Company Name
Company Name of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_company_name_2:
string
Title:
Sold To Company Name 2
Secondary Company Name of the buying organization for this transation linked from the ERP System.This is functionally eqivalent to the Customer contact information. -
_soldTo_t_country:
object Sold To Country
Title:
Sold To Country
-
_soldTo_t_email:
string
Title:
Sold To Email
Email Address for the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_fax:
string
Title:
Sold To Fax
Fax Number for the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_first_name:
string
Title:
Sold To First Name
First Name of the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_last_name:
string
Title:
Sold To Last Name
Last Name of the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_phone:
string
Title:
Sold To Phone
Phone Number for the contact person for the buying organization linked from the ERP System.This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_state:
object Sold To State
Title:
Sold To State
-
_soldTo_t_zip:
string
Title:
Sold To Zip
Zip Code of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_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
-
_submitted_by_submit_t:
string
Title:
Submitted By[Submit]
Login of Submitter. Only populated after corresponding submit action is performed. -
_supplier_company_name:
string
Title:
_supplier_company_name
-
_transaction_total:
object Transaction Total (Net)
Title:
Transaction Total (Net)
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. -
accountAddressElementAttribute1_t:
string
Title:
Account AddressElementAttribute1
Account AddressElementAttribute1 -
accountAddressElementAttribute2_t:
string
Title:
Account AddressElementAttribute2
Account AddressElementAttribute2 -
accountAddressElementAttribute3_t:
string
Title:
Account AddressElementAttribute3
Account AddressElementAttribute3 -
accountAddressElementAttribute4_t:
string
Title:
Account AddressElementAttribute4
Account AddressElementAttribute4 -
accountAddressElementAttribute5_t:
string
Title:
Account AddressElementAttribute5
Account AddressElementAttribute5 -
accountAddressLine1_t:
string
Title:
Account AddressLine1
First line of the account address -
accountAddressLine2_t:
string
Title:
Account AddressLine2
Second line of the account address -
accountAddressLine3_t:
string
Title:
Account AddressLine3
Third line of the account address -
accountAddressLine4_t:
string
Title:
Account AddressLine4
Fourth line of the account address -
accountCity_t:
string
Title:
Account City
City of the account -
accountCountry_t:
string
Title:
Account Country
Country of the account -
accountEmailAddress_t:
string
Title:
Account EmailAddress
Email address of the account -
accountFirstName_t:
string
Title:
Account First Name
First Name of the Account Contact -
accountLastName_t:
string
Title:
Account Last Name
Last Name of the Account Contact -
accountMiddleName_t:
string
Title:
Account Middle Name
Middle Name of the Account Contact -
accountName_t:
string
Title:
Account Name
The attribute which captures the name of the Account -
accountNameSuffix_t:
string
Title:
Account Name Suffix
Name suffix of the Account contact -
accountPostalCode_t:
integer
Title:
Account PostalCode
Postal Code of the account -
accountProvince_t:
string
Title:
Account Province
Province of the account -
accountState_t:
string
Title:
Account State
State of the account -
accountType_t:
object Account Type
Title:
Account Type
-
accountUniqueName_t:
string
Title:
Account Unique Name
Unique identifier for the Account contact -
addressType_t:
object Account AddressType
Title:
Account AddressType
-
annualContractListValue_t:
object Annual Contract Value (List)
Title:
Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing. -
approval_history_submit_t:
array Approval History[Submit]
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:
integer
Title:
Approval Revision[Submit]
This attribute tracks the number of times a quote has been revised -
approval_status_submit_t:
array Approval Status[Submit]
Title:
Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction. -
approve_reject_icon_submit_t:
array 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. -
billToSiteUseId_t:
string
Title:
Bill To Site Use Id
CDM integration will provide value to this field based on Customer company name -
bs_id:
string
Title:
Transaction Internal ID
Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. -
businessUnitId_t:
string
Title:
Business Unit ID
Customer business unit identifier. -
businessUnitName_t:
string
Title:
Business Unit Name
Customer business unit name. -
cancelExplanation_t:
string
Title:
Cancel Explanation
A detailed, free-form explanation of why the customer cancelled the sales order. This supplements the Cancel Reason selected by the sales user. -
cancelReason_t:
object Cancel Reason
Title:
Cancel Reason
-
contactAddressElementAttribute1_t:
string
Title:
Contact AddressElementAttribute1
Contact AddressElementAttribute1 -
contactAddressElementAttribute2_t:
string
Title:
Contact AddressElementAttribute2
Contact AddressElementAttribute2 -
contactAddressElementAttribute3_t:
string
Title:
Contact AddressElementAttribute3
Contact AddressElementAttribute3 -
contactAddressElementAttribute4_t:
string
Title:
Contact AddressElementAttribute4
Contact AddressElementAttribute4 -
contactAddressElementAttribute5_t:
string
Title:
Contact AddressElementAttribute5
Contact AddressElementAttribute5 -
contactAddressLine1_t:
string
Title:
Contact AddressLine1
First line of the contact address -
contactAddressLine2_t:
string
Title:
Contact AddressLine2
Second line of the contact address -
contactAddressLine3_t:
string
Title:
Contact AddressLine3
Third line of the contact address -
contactAddressLine4_t:
string
Title:
Contact AddressLine4
Fourth line of the contact address -
contactCity_t:
string
Title:
Contact City
City of the contact -
contactCountry_t:
string
Title:
Contact Country
Country of the contact -
contactEmailAddress_t:
string
Title:
Contact Email Address
Email address of the contact -
contactFirstName_t:
string
Title:
Contact First Name
First Name of the Contact -
contactLastName_t:
string
Title:
Contact Last Name
Last Name of the Contact -
contactMiddleName_t:
string
Title:
Contact Middle Name
Middle Name of the Contact -
contactName_t:
string
Title:
Contact Name
The attribute which captures the Contact Name of the Account -
contactNameSuffix_t:
string
Title:
Contact Name Suffix
Name suffix of the contact -
contactPostalCode_t:
string
Title:
Contact PostalCode
Postal Code of the contact -
contactProvince_t:
string
Title:
Contact Province
Province of the contact -
contactState_t:
string
Title:
Contact State
State of the contact -
contactType_t:
object Contact Type
Title:
Contact Type
-
contactUniqueName_t:
string
Title:
Contact Unique Name
Unique identifier for the Account contact -
contractedPeriods_t:
integer
Title:
Contracted Periods
Number of periods the customer has contracted to receive the transaction. -
contractEndDate_t:
string
Title:
Contract End Date
Date that the customer stops receiving all of the products and services on the quote. Used when all services are co-terminated at the quote level. -
contractName_t:
string
Title:
Contract Name
The attribute which captures the name of the CLM contract -
contractStartDate_t:
string
Title:
Contract Start Date
Date that the customer starts to receive all of the products and services on the quote. Used when all services are co-terminated at the quote level. -
contractTypeName_t:
string
Title:
Contract Type Name
The attribute which captures the contract type name of the CLM contract -
coverLetter_t:
string
Title:
Cover Letter
The cover letter to be attached to the proposal document for this transaction. -
createdBy_t:
string
Title:
Created By
The person that created the transaction. -
createdDate_t:
string
Title:
Created Date
The date when the transaction was created. -
createOrderRestResponse:
string
Title:
Create Order Rest Response
This attribute holds the rest response of create order -
currency_t:
object Currency
Title:
Currency
-
currentStepForTesting_tempDisplay_t:
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. -
defaultRequestDate_t:
string
Title:
Default Request Date
The date on which the user requests that fulfillment occur for this transaction. -
fileAttachment_t:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
freezePriceFlag_t:
boolean
Title:
Freeze Price Flag
Determines whether the external system should use CPQ Pricing or not. If set to true, the external system will use CPQ Pricing. -
fulfillmentStatus_t:
object Fulfillment Status
Title:
Fulfillment Status
-
hasRecurringPricing_t:
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:
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. -
lastPricedDate_t:
string
Title:
Last Priced
The date and time that this transaction was last re-priced. -
lastUpdatedBy_t:
string
Title:
Last Updated By
The person that last updated this transaction. -
lastUpdatedDate_t:
string
Title:
Last Updated
The date and time the transaction was last updated. -
opportunityID_t:
string
Title:
Opportunity ID
The identifier of the parent opportunity. -
opportunityName_t:
string
Title:
Opportunity Name
The name of the parent opportunity. -
opportunityNumber_t:
string
Title:
Opportunity Number
The user or public identifier for the opportunity associated to this transaction. -
oRCL_billingFrequency_t:
object Billing Frequency
Title:
Billing Frequency
-
oRCL_ERP_OrderID_t:
string
Title:
Order ID
The Order ID assigned by the external ERP system to this transaction. -
oRCL_ERP_OrderNumber_t:
string
Title:
Order Number
The order number assigned by the external Order Management and ERP system. -
oRCL_ERP_PartialShipAllowed_t:
boolean
Title:
Partial Ship Allowed
Indicates whether partial shipment of the requested quantity is acceptable to the customer. -
oRCL_SFA_OwnerResourcePartyID_t:
string
Title:
Owner Resource Party ID
The SFA Party ID for the person owning this transaction. -
oRCL_SFA_PrimaryOrgID_t:
string
Title:
Primary Org ID
The primary organization in SFA associated with this transaction or owner. -
oRCL_SFA_Status_t:
string
Title:
Opportunity Win/Loss Status
The current status of this transaction as it relates to SFA. This will differ from the other statuses of the transaction. The mapping of SFA status values to the statuses used in CPQ Cloud is administered in the Status data table. -
oRCL_SFA_SyncTime_t:
string
Title:
Last Opportunity Sync
The date and time on which the transaction was last synced to SFA. -
oRCL_SFA_TransactionID_t:
string
Title:
Partner Transaction ID
The ID generated by SFA to identify this transaction. -
orderDate_t:
string
Title:
Order Date
The date and time the order was placed for fulfillment. -
orderKey_t:
string
Title:
Order Key
Value that uniquely identifies the sales order. -
orderPlacedBy_t:
string
Title:
Ordered By
Records the Current User when the Create Order Action is triggered -
owner_t:
string
Title:
Owner
The person that owns this transaction. -
parent_transaction_id_versionTransaction_t:
string
Title:
Parent Transaction Id[Version Transaction]
This Attribute contains the parent transaction id. -
partialShipAllowedFlag_t:
boolean
Title:
Partial Ship Allowed Flag
Indicates whether partial shipment of the requested quantity is acceptable to the customer. -
paymentTerms_t:
object Payment Terms
Title:
Payment Terms
-
priceExpirationDate_t:
string
Title:
Price Expiration Date
The date the price quote will expire. -
priceScore_t:
integer
Title:
Price Score
The total calculated price score for this transaction, based on an average weighted price score on each line based upon total Contract Value at List price. -
priceType_t:
object Price Type
Title:
Price Type
-
priceWithinPolicy_t:
boolean
Title:
Price Within Policy
Indicates whether the prices in this transaction are all within their discount authority. -
primaryFlag_t:
boolean
Title:
Primary Flag
Indicates that this quote is used as the basis for updating revenues on an associated opportunity. -
proposalExists_t:
boolean
Title:
Proposal Exists
Indicates whether the transaction has Proposal Document that can be viewed within the CRM or other integrated system. -
purchaseOrderNumber_t:
string
Title:
PO Number
The purchase order number provided by the customer. -
rejectExplanation_t:
string
Title:
Reject Explanation
A detailed, free-form explanation of why the customer rejected the deal. -
rejectReason_t:
object Reject Reason
Title:
Reject Reason
-
renewalErrorEmailAddress_t:
string
Title:
Renewal Error Email Address
The email address to be used to report an error in the automated renewal process. A distribution list email should be used if a department or group is to be notified. -
renewalProcess_t:
object Renewal Process
Title:
Renewal Process
-
renewalProcessUsed_t:
object Renewal Process Used
Title:
Renewal Process Used
-
renewDraftSubscriptionNumber_t:
string
Title:
Renew Draft Subscription Number
Subscription management contract ID for the draft subscription used in the renewal process. -
requireApprovalIfChecked_temporary_t:
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:
object Sales Channel
Title:
Sales Channel
-
status_t:
object Status
Title:
Status
-
subscription_Status_t:
string
Title:
Subscription Status
The status of the subscription order -
subscriptionProfileId_t:
string
Title:
SubscriptionProfileId
Customer subscription profile identifier to be used in subscription management to specify subscription contract preferences. -
totalAnnualCostAmount_t:
object Annual Cost
Title:
Annual Cost
The total of recurring extended costs each year for the transaction. -
TotalAnnualDiscount_t:
object Annual Contract Discount
Title:
Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction. -
totalAnnualMarginAmount_t:
object Annual Margin
Title:
Annual Margin
The total of recurring extended margins each year for the transaction. -
totalAnnualValue_t:
object Annual Contract Value(Net)
Title:
Annual Contract Value(Net)
The total value of recurring charges each year. -
totalContractCostAmount_t:
object Total Contract Cost
Title:
Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs. -
totalContractDiscount_t:
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. -
totalContractListValue_t:
object Total Contract Value (List)
Title:
Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List). -
totalContractMarginAmount_t:
object Total Contract Margin
Title:
Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values. -
totalContractValue_t:
object Total Contract Value (Net)
Title:
Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. -
totalMonthlyCostAmount_t:
object Total Monthly Cost
Title:
Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month. -
totalMonthlyDiscount_t:
object Total Discount Per Month
Title:
Total Discount Per Month
The total of discounts off monthly recurring charges. -
totalMonthlyListAmount_t:
object Total (List) Per Month
Title:
Total (List) Per Month
The total of all monthly recurring list amounts on the lines. -
totalMonthlyMarginAmount_t:
object Total Monthly Margin
Title:
Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction. -
totalMonthlyNetAmount_t:
object Total (Net) Per Month
Title:
Total (Net) Per Month
The total of all monthly recurring net amounts on the lines. -
totalMonthlyUsageRev_t:
object Total MUR (Net)
Title:
Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction. -
totalOneTimeCostAmount_t:
object Total One-Time Cost
Title:
Total One-Time Cost
The total of extended costs for all one-time charges for the transaction. -
totalOneTimeDiscount_t:
object Total Discount
Title:
Total Discount
The total of all extended discount amounts for one time??pricing/charges. -
totalOneTimeListAmount_t:
object Total (List)
Title:
Total (List)
The total of all one-time charges on the lines. -
totalOneTimeMarginAmount_t:
object Total One-Time Margin
Title:
Total One-Time Margin
The total of extended margins for all one-time charges for the transaction. -
totalOneTimeNetAmount_t:
object Total (Net)
Title:
Total (Net)
The total one time net charge. -
totalRecurRevenue_t:
object Total Recurring Revenue (Net)
Title:
Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction. -
totalUsageRevenue_t:
object Total Usage Revenue (Net)
Title:
Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction. -
transactionDescription_t:
string
Title:
Transaction Description
Description of the CPQ Transaction. -
transactionID_t:
string
Title:
Transaction Number
The number or public unique identifier of the transaction. -
transactionLine:
object TransactionLine-collection
-
transactionMarginPercent_t:
number
Title:
Total Transaction Margin %
The percentage of the total list price for which this transaction 's margin accounts. -
transactionName_t:
string
Title:
Transaction Name
Attribute which captures the user entered Transaction Name -
transactionSourceSystem_t:
string
Title:
Transaction Source System
The code used to identify CPQ as the source for this transaction. -
transactionTotalDiscountPercent_t:
number
Title:
Total Discount %
The percentage of the Total Transaction (List) that is discounted off of the transaction. One-time and recurring pricing for the specified contract duration are included. -
triggerUpdateAssetForLineStatus_t:
string
Title:
Trigger Update Asset for Line Status
List of line.status_l values which indicate that line has finished processing on FOM and is ready to move to asset in CPQ(pending other lines' s status within same root). -
userKey_t:
string
Title:
Transaction Version User Key
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:
string
Title:
Version Number
This Attribute Lists the Version Number for a document. -
version_t:
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). -
winLossStatus_t:
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 : _currency_pref
Type:
object
Title:
Show Source
_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 : Customer Country
Type:
object
Title:
Show Source
Customer Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer State
Type:
object
Title:
Show Source
Customer State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : CmAttachmentAttribute
Type:
object
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute
Show Source
-
fileId:
string
Identifier of permanent or temporary record holding file content
-
fileLocation:
string
URI to perform download / upload operations; GET can be performed only when isFileSaved is true
-
fileName:
string
Attached file name
-
fileType:
string
MIME type of attached file content
-
isFileSaved:
boolean
Indicates that file is saved in permanent storage location or just uploaded in temporary location
Nested Schema : eSignature Status[eSignature Attribute Set]
Type:
object
Title:
Show Source
eSignature Status[eSignature Attribute Set]
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : eSignature Status[esig Test]
Type:
object
Title:
Show Source
eSignature Status[esig Test]
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Invoice To Country
Type:
object
Title:
Show Source
Invoice To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Invoice To State
Type:
object
Title:
Show Source
Invoice To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
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 : Revenue Category
Type:
object
Title:
Show Source
Revenue Category
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Assigned To
Type:
object
Title:
Show Source
Assigned To
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Bill To Country
Type:
object
Title:
Show Source
Bill To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Bill To State
Type:
object
Title:
Show Source
Bill To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer Status
Type:
object
Title:
Show Source
Customer Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer Visibility Identifier
Type:
object
Title:
Show Source
Customer Visibility Identifier
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Source Of Transaction
Type:
object
Title:
Show Source
Source Of Transaction
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Ship To Country
Type:
object
Title:
Show Source
Ship To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Ship To State
Type:
object
Title:
Show Source
Ship To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sold To Country
Type:
object
Title:
Show Source
Sold To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sold To State
Type:
object
Title:
Show Source
Sold To State
-
displayValue:
string
Title:
displayValue
-
value:
string
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 : Transaction Total (Net)
Type:
object
Title:
Transaction Total (Net)
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Account Type
Type:
object
Title:
Show Source
Account Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Account AddressType
Type:
object
Title:
Show Source
Account AddressType
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Annual Contract Value (List)
Type:
object
Title:
Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Approval History[Submit]
Type:
array
Title:
Approval History[Submit]
This attribute records approval history of a transaction.If a reason is reset, it is erased from the approval history.
Show Source
-
Array of:
object Approval History
Title:
Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Approval Status[Submit]
Type:
array
Title:
Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction.
Show Source
-
Array of:
object Approval Reject Status
Title:
Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Nested Schema : My Approval[Submit]
Type:
array
Title:
My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
-
Array of:
object Approval Reject Icon
Title:
Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Nested Schema : Cancel Reason
Type:
object
Title:
Show Source
Cancel Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Contact Type
Type:
object
Title:
Show Source
Contact Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Currency
Type:
object
Title:
Show Source
Currency
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Fulfillment Status
Type:
object
Title:
Show Source
Fulfillment Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Billing Frequency
Type:
object
Title:
Show Source
Billing Frequency
-
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 : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Reject Reason
Type:
object
Title:
Show Source
Reject Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Renewal Process
Type:
object
Title:
Show Source
Renewal Process
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Renewal Process Used
Type:
object
Title:
Show Source
Renewal Process Used
-
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 : Annual Cost
Type:
object
Title:
Annual Cost
The total of recurring extended costs each year for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Margin
Type:
object
Title:
Annual Margin
The total of recurring extended margins each year for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Contract Value(Net)
Type:
object
Title:
Annual Contract Value(Net)
The total value of recurring charges each year.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Cost
Type:
object
Title:
Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Value (List)
Type:
object
Title:
Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List).
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Margin
Type:
object
Title:
Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Value (Net)
Type:
object
Title:
Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Monthly Cost
Type:
object
Title:
Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (List) Per Month
Type:
object
Title:
Total (List) Per Month
The total of all monthly recurring list amounts on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Monthly Margin
Type:
object
Title:
Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (Net) Per Month
Type:
object
Title:
Total (Net) Per Month
The total of all monthly recurring net amounts on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total MUR (Net)
Type:
object
Title:
Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total One-Time Cost
Type:
object
Title:
Total One-Time Cost
The total of extended costs for all one-time charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Discount
Type:
object
Title:
Total Discount
The total of all extended discount amounts for one time??pricing/charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (List)
Type:
object
Title:
Total (List)
The total of all one-time charges on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total One-Time Margin
Type:
object
Title:
Total One-Time Margin
The total of extended margins for all one-time charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (Net)
Type:
object
Title:
Total (Net)
The total one time net charge.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Recurring Revenue (Net)
Type:
object
Title:
Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Usage Revenue (Net)
Type:
object
Title:
Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : TransactionLine-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 : Win/Loss Status
Type:
object
Title:
Show Source
Win/Loss Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
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 : Approval History
Type:
object
Title:
Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
-
actionPerformed:
string
Title:
actionPerformed
String value that specifies actionPerformed. -
performDate:
string
Title:
performDate
Date value that specifies performDate. -
performerComment:
string
Title:
performerComment
String value that specifies performerComment. -
performerCompany:
string
Title:
performerCompany
String value that specifies performerCompany. -
performerName:
string
Title:
performerName
String value that specifies performerName. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName. -
revisionNumber:
integer
Title:
revisionNumber
Integer value that specifies revisionNumber.
Nested Schema : Approval Reject Status
Type:
object
Title:
Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Show Source
-
approverNames:
array approverNames
Title:
approverNames
String value that specifies approverNames. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName.
Nested Schema : approverNames
Type:
array
Title:
approverNames
String value that specifies approverNames.
Show Source
-
Array of:
string
String value of an element 's unique identifier.
Nested Schema : Approval Reject Icon
Type:
object
Title:
Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Show Source
-
approvalId:
integer
Title:
approvalId
Integer value that specifies approvalId. -
approveActionId:
integer
Title:
approveActionId
Integer value that specifies approveActionId. -
approveActionLabel:
string
Title:
approveActionLabel
String value that specifies approveActionLabel. -
approveIcon:
string
Title:
approveIcon
String value that specifies approveIcon. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName. -
rejectActionId:
integer
Title:
rejectActionId
Integer value that specifies rejectActionId. -
rejectIcon:
string
Title:
rejectIcon
String value that specifies rejectIcon. -
rejectIconLabel:
string
Title:
rejectIconLabel
String value that specifies approveActionLabel.
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 Transaction Line
Title:
Transaction Line
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 : 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 : 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 : 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 : 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 : items
Type:
Show Source
array
-
Array of:
object Available Rate Plan Set
Title:
Available Rate Plan Set
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.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Transaction-ReviseResponse
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
Title:
Transaction
-
reason_var_name:
string
Title:
Reason Variable Name
While requesting approval, performer is supposed to choose reason preconfigured in approval workflow for seeking approval -
revisionId:
string
Title:
Revision Id
The string parameter that contains the revision information. -
warnings:
object warnings
Title:
warnings
warning messages
Nested Schema : Transaction
Type:
object
Title:
Show Source
Transaction
-
_approve_link:
string
Title:
Approve Link
Links to auto-generate approve response. This is only populated in advanced notification email rules. -
_buyer_company_name:
string
Title:
_buyer_company_name
-
_currency_pref:
object _currency_pref
Title:
_currency_pref
-
_customer_id:
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:
string
Title:
Customer Address
First Line for the Address of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_address_2:
string
Title:
Customer Address 2
Second Line for the Address of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_city:
string
Title:
Customer City
City of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_company_name:
string
Title:
Customer Company Name
Company Name of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_customer_t_company_name_2:
string
Title:
Customer Company Name 2
Secondary Company Name of the buying organization for this transation linked from the CRM System.This is functionally eqivalent to the Sold To company. -
_customer_t_country:
object Customer Country
Title:
Customer Country
-
_customer_t_email:
string
Title:
Customer Email
Email Address of the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_fax:
string
Title:
Customer Fax
Fax Number for the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_first_name:
string
Title:
Customer First Name
First Name of the contact person for the buying organization linked from the CRM System.This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_last_name:
string
Title:
Customer Last Name
Last Name of the contact person for the buying organization linked from the CRM System.This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_phone:
string
Title:
Customer Phone
Phone Number for the contact person for the buying organization linked from the CRM System. This is functionally eqivalent to the Sold To contact information linked from the ERP System. -
_customer_t_state:
object Customer State
Title:
Customer State
-
_customer_t_zip:
string
Title:
Customer Zip
Zip Code of the buying organization for this transation linked from the CRM System. This is functionally eqivalent to the Sold To company. -
_date_added:
string
Title:
_date_added
-
_date_modified:
string
Title:
_date_modified
-
_date_tx_modified:
string
Title:
_date_tx_modified
-
_document_number:
string
Title:
Document Number
Unique doc number to be used as document identifier in a process -
_document_var_name:
string
Title:
_document_var_name
-
_eSignatureAttributeSet_esig_date_modified:
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:
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:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
_eSignatureAttributeSet_esig_recipients:
string
Title:
eSignature Recipients[eSignature Attribute Set]
The Recipients holds the emails and names of the intended recipients -
_eSignatureAttributeSet_esig_status:
object eSignature Status[eSignature Attribute Set]
Title:
eSignature Status[eSignature Attribute Set]
-
_esigTest_c_esig_date_modified:
string
Title:
eSignature Date Modified[esig Test]
The Date Modified field contains the date of the most recently performed action on this document -
_esigTest_c_esig_envelope_id:
string
Title:
eSignature Envelope ID[esig Test]
The Envelope ID is a hidden field that is sent along with the document to the eSignature Vendor -
_esigTest_c_esig_file_attachment:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
_esigTest_c_esig_recipients:
string
Title:
eSignature Recipients[esig Test]
The Recipients holds the emails and names of the intended recipients -
_esigTest_c_esig_status:
object eSignature Status[esig Test]
Title:
eSignature Status[esig Test]
-
_id:
integer
Title:
_id
-
_invoiceTo_t_address:
string
Title:
Invoice To Address
First Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_address_2:
string
Title:
Invoice To Address 2
Second Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_city:
string
Title:
Invoice To City
City of the organization being billed for this transaction. -
_invoiceTo_t_company_name:
string
Title:
Invoice To Company Name
Company Name of the organization being billed for this transaction. -
_invoiceTo_t_company_name_2:
string
Title:
Invoice To Company Name 2
Secondary Company Name of the organization being billed for this transaction. -
_invoiceTo_t_country:
object Invoice To Country
Title:
Invoice To Country
-
_invoiceTo_t_email:
string
Title:
Invoice To Email
Email Address of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_fax:
string
Title:
Invoice To Fax
Fax Number for the contact person for the organization being billed for this transaction. -
_invoiceTo_t_first_name:
string
Title:
Invoice To First Name
First Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_last_name:
string
Title:
Invoice To Last Name
Last Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_phone:
string
Title:
Invoice To Phone
Phone Number for the contact person for the organization being billed for this transaction. -
_invoiceTo_t_state:
object Invoice To State
Title:
Invoice To State
-
_invoiceTo_t_zip:
string
Title:
Invoice To Zip
Zip Code of the organization being billed for this transaction. -
_last_document_number:
integer
Title:
_last_document_number
-
_lock_status:
boolean
Title:
_lock_status
-
_locked_by_user:
integer
Title:
_locked_by_user
-
_locked_by_user_first_name:
string
Title:
_locked_by_user_first_name
First name of User who locked the trasnaction -
_locked_by_user_last_name:
string
Title:
_locked_by_user_last_name
Last Name of User who locked the trasnaction -
_locked_by_user_login:
string
Title:
_locked_by_user_login
Login of User who locked the trasnaction -
_locked_time:
string
Title:
_locked_time
-
_partner_price_book_id:
string
Title:
Partner Price Book Id
Partner Price Book Id -
_pp_id:
integer
Title:
_pp_id
-
_pp_name:
string
Title:
_pp_name
-
_price_book_custom_field_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. -
_price_book_custom_fields:
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_book_desc:
string
Title:
Price Book Description
Price Book Description -
_price_book_name:
string
Title:
Price Book Name
Price Book Name -
_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 -
_process_var_name:
string
Title:
_process_var_name
-
_reject_link:
string
Title:
Reject Link
Links to auto-generate reject response. This is only populated in advanced notification email rules. -
_revenueCategory_t:
object Revenue Category
Title:
Revenue Category
-
_s_accountContactNumber_t:
string
Title:
Account Contact Number
Contact number of the account. -
_s_accountIntegrationResponse_t:
string
Title:
Account Integration Response
Holds the response of TCA account integration. -
_s_accountPartyId_t:
string
Title:
Account PartyId
The CDM integration provides the value for this field based on the Customer Company Name -
_s_accountPartyNumber_t:
string
Title:
Account Party Number
Identifier for the type of the account under the party. -
_s_assignedTo_t:
object Assigned To
Title:
Assigned To
-
_s_billTo_t_address:
string
Title:
Bill To Address
-
_s_billTo_t_address_2:
string
Title:
Bill To Address 2
-
_s_billTo_t_city:
string
Title:
Bill To City
-
_s_billTo_t_company_name:
string
Title:
Bill To Company Name
-
_s_billTo_t_company_name_2:
string
Title:
Bill To Company Name 2
-
_s_billTo_t_country:
object Bill To Country
Title:
Bill To Country
-
_s_billTo_t_email:
string
Title:
Bill To Email
-
_s_billTo_t_fax:
string
Title:
Bill To Fax
-
_s_billTo_t_first_name:
string
Title:
Bill To First Name
-
_s_billTo_t_last_name:
string
Title:
Bill To Last Name
-
_s_billTo_t_phone:
string
Title:
Bill To Phone
-
_s_billTo_t_state:
object Bill To State
Title:
Bill To State
-
_s_billTo_t_zip:
string
Title:
Bill To Zip
-
_s_billToCustomerAccountID_t:
string
Title:
Bill to Customer Account Id
TCA account integration provides value from BillingAccountId to this field based on Customer Id and Business Unit ID -
_s_billToCustomerAccountName_t:
string
Title:
Bill To Customer Account Name
TCA account integration provides value from BillingAccountName to this field based on Customer Id and Business Unit ID -
_s_contactNumber_t:
string
Title:
Contact Number
Contact number of the contact. -
_s_contactPartyNumber_t:
string
Title:
Contact Party Number
Identifier for the type of the contact under the party. -
_s_contractID_t:
string
Title:
Contract ID
The identifier of the CLM contract -
_s_contractTypeID_t:
string
Title:
Contract Type ID
The identifier for the CLM contract Type. -
_s_customerPartySiteID_t:
string
Title:
Customer Party Site ID
The ID for the Party Site or Address of the CRM Customer. -
_s_customerStatus_t:
object Customer Status
Title:
Customer Status
-
_s_customerVisibilityIdentifier_t:
object Customer Visibility Identifier
Title:
Customer Visibility Identifier
-
_s_hostCompanyFullName_t:
string
Title:
Host Company Full Name
Full company name of current user' s company. -
_s_invoiceToPartySiteID_t:
string
Title:
Invoice To Party Site ID
The ID for the Party Site or Address of the Invoice To party. -
_s_isPublished_t:
boolean
Title:
Is Published
Indicates whether this quote was published to customer. This flag is set to true when the quote is published for the first time. -
_s_shipToPartyID_t:
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. -
_s_shipToPartySiteID_t:
string
Title:
Ship To Party Site ID
The ID for the Party Site or Address of the Ship To party. -
_s_soldToCustomerAccountID_t:
string
Title:
Sold To Customer Account ID
The unique internal identifier for the Sold To Customer Account used for credit checking and collections. The Sold To Customer Account is typically mastered in an external ERP or Financials system and referenced when CPQ integrates sales orders to these systems. A Sold To Customer Account is typically associated to a Bill To address but may be associated with more than one. -
_s_soldToPartyID_t:
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. -
_s_soldToPartyName_t:
string
Title:
Sold To Party Name
TCA account integration provides value from PartyName to this field based on Customer Id and Business Unit ID -
_s_soldToPartySiteID_t:
string
Title:
Sold To Party Site ID
The ID for the Party Site or Address of the Sold To party. -
_s_subscriptionId_t:
string
Title:
Subscription ID
The identifier of the subscription contract. -
_s_transactionSource_t:
object Source Of Transaction
Title:
Source Of Transaction
-
_shipTo_t_address:
string
Title:
Ship To Address
First Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_address_2:
string
Title:
Ship To Address 2
Second Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_city:
string
Title:
Ship To City
City of the organization where this transaction will be shipped. -
_shipTo_t_company_name:
string
Title:
Ship To Company Name
Company Name of the organization where this transaction will be shipped. -
_shipTo_t_company_name_2:
string
Title:
Ship To Company Name 2
Secondary Company Name of the organization where this transaction will be shipped. -
_shipTo_t_country:
object Ship To Country
Title:
Ship To Country
-
_shipTo_t_email:
string
Title:
Ship To Email
Email Address for the contact person for the organization to which this order will be shipped. -
_shipTo_t_fax:
string
Title:
Ship To Fax
Fax Number for the contact person for the organization to which this order will be shipped. -
_shipTo_t_first_name:
string
Title:
Ship To First Name
First Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_last_name:
string
Title:
Ship To Last Name
Last Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_phone:
string
Title:
Ship To Phone
Phone Number for the contact person for the organization to which this order will be shipped. -
_shipTo_t_state:
object Ship To State
Title:
Ship To State
-
_shipTo_t_zip:
string
Title:
Ship To Zip
Zip Code of the organization where this transaction will be shipped. -
_soldTo_t_address:
string
Title:
Sold To Address
First Line of the Address of the buying organization for this transation linked from the ERP System.This is functionally eqivalent to the Customer contact information. -
_soldTo_t_address_2:
string
Title:
Sold To Address 2
Second Line of the Address of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_city:
string
Title:
Sold To City
City of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_company_name:
string
Title:
Sold To Company Name
Company Name of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_soldTo_t_company_name_2:
string
Title:
Sold To Company Name 2
Secondary Company Name of the buying organization for this transation linked from the ERP System.This is functionally eqivalent to the Customer contact information. -
_soldTo_t_country:
object Sold To Country
Title:
Sold To Country
-
_soldTo_t_email:
string
Title:
Sold To Email
Email Address for the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_fax:
string
Title:
Sold To Fax
Fax Number for the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_first_name:
string
Title:
Sold To First Name
First Name of the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_last_name:
string
Title:
Sold To Last Name
Last Name of the contact person for the buying organization linked from the ERP System. This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_phone:
string
Title:
Sold To Phone
Phone Number for the contact person for the buying organization linked from the ERP System.This is functionally eqivalent to the Customer contact information linked from the CRM System. -
_soldTo_t_state:
object Sold To State
Title:
Sold To State
-
_soldTo_t_zip:
string
Title:
Sold To Zip
Zip Code of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_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
-
_submitted_by_submit_t:
string
Title:
Submitted By[Submit]
Login of Submitter. Only populated after corresponding submit action is performed. -
_supplier_company_name:
string
Title:
_supplier_company_name
-
_transaction_total:
object Transaction Total (Net)
Title:
Transaction Total (Net)
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. -
accountAddressElementAttribute1_t:
string
Title:
Account AddressElementAttribute1
Account AddressElementAttribute1 -
accountAddressElementAttribute2_t:
string
Title:
Account AddressElementAttribute2
Account AddressElementAttribute2 -
accountAddressElementAttribute3_t:
string
Title:
Account AddressElementAttribute3
Account AddressElementAttribute3 -
accountAddressElementAttribute4_t:
string
Title:
Account AddressElementAttribute4
Account AddressElementAttribute4 -
accountAddressElementAttribute5_t:
string
Title:
Account AddressElementAttribute5
Account AddressElementAttribute5 -
accountAddressLine1_t:
string
Title:
Account AddressLine1
First line of the account address -
accountAddressLine2_t:
string
Title:
Account AddressLine2
Second line of the account address -
accountAddressLine3_t:
string
Title:
Account AddressLine3
Third line of the account address -
accountAddressLine4_t:
string
Title:
Account AddressLine4
Fourth line of the account address -
accountCity_t:
string
Title:
Account City
City of the account -
accountCountry_t:
string
Title:
Account Country
Country of the account -
accountEmailAddress_t:
string
Title:
Account EmailAddress
Email address of the account -
accountFirstName_t:
string
Title:
Account First Name
First Name of the Account Contact -
accountLastName_t:
string
Title:
Account Last Name
Last Name of the Account Contact -
accountMiddleName_t:
string
Title:
Account Middle Name
Middle Name of the Account Contact -
accountName_t:
string
Title:
Account Name
The attribute which captures the name of the Account -
accountNameSuffix_t:
string
Title:
Account Name Suffix
Name suffix of the Account contact -
accountPostalCode_t:
integer
Title:
Account PostalCode
Postal Code of the account -
accountProvince_t:
string
Title:
Account Province
Province of the account -
accountState_t:
string
Title:
Account State
State of the account -
accountType_t:
object Account Type
Title:
Account Type
-
accountUniqueName_t:
string
Title:
Account Unique Name
Unique identifier for the Account contact -
addressType_t:
object Account AddressType
Title:
Account AddressType
-
annualContractListValue_t:
object Annual Contract Value (List)
Title:
Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing. -
approval_history_submit_t:
array Approval History[Submit]
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:
integer
Title:
Approval Revision[Submit]
This attribute tracks the number of times a quote has been revised -
approval_status_submit_t:
array Approval Status[Submit]
Title:
Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction. -
approve_reject_icon_submit_t:
array 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. -
billToSiteUseId_t:
string
Title:
Bill To Site Use Id
CDM integration will provide value to this field based on Customer company name -
bs_id:
string
Title:
Transaction Internal ID
Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. -
businessUnitId_t:
string
Title:
Business Unit ID
Customer business unit identifier. -
businessUnitName_t:
string
Title:
Business Unit Name
Customer business unit name. -
cancelExplanation_t:
string
Title:
Cancel Explanation
A detailed, free-form explanation of why the customer cancelled the sales order. This supplements the Cancel Reason selected by the sales user. -
cancelReason_t:
object Cancel Reason
Title:
Cancel Reason
-
contactAddressElementAttribute1_t:
string
Title:
Contact AddressElementAttribute1
Contact AddressElementAttribute1 -
contactAddressElementAttribute2_t:
string
Title:
Contact AddressElementAttribute2
Contact AddressElementAttribute2 -
contactAddressElementAttribute3_t:
string
Title:
Contact AddressElementAttribute3
Contact AddressElementAttribute3 -
contactAddressElementAttribute4_t:
string
Title:
Contact AddressElementAttribute4
Contact AddressElementAttribute4 -
contactAddressElementAttribute5_t:
string
Title:
Contact AddressElementAttribute5
Contact AddressElementAttribute5 -
contactAddressLine1_t:
string
Title:
Contact AddressLine1
First line of the contact address -
contactAddressLine2_t:
string
Title:
Contact AddressLine2
Second line of the contact address -
contactAddressLine3_t:
string
Title:
Contact AddressLine3
Third line of the contact address -
contactAddressLine4_t:
string
Title:
Contact AddressLine4
Fourth line of the contact address -
contactCity_t:
string
Title:
Contact City
City of the contact -
contactCountry_t:
string
Title:
Contact Country
Country of the contact -
contactEmailAddress_t:
string
Title:
Contact Email Address
Email address of the contact -
contactFirstName_t:
string
Title:
Contact First Name
First Name of the Contact -
contactLastName_t:
string
Title:
Contact Last Name
Last Name of the Contact -
contactMiddleName_t:
string
Title:
Contact Middle Name
Middle Name of the Contact -
contactName_t:
string
Title:
Contact Name
The attribute which captures the Contact Name of the Account -
contactNameSuffix_t:
string
Title:
Contact Name Suffix
Name suffix of the contact -
contactPostalCode_t:
string
Title:
Contact PostalCode
Postal Code of the contact -
contactProvince_t:
string
Title:
Contact Province
Province of the contact -
contactState_t:
string
Title:
Contact State
State of the contact -
contactType_t:
object Contact Type
Title:
Contact Type
-
contactUniqueName_t:
string
Title:
Contact Unique Name
Unique identifier for the Account contact -
contractedPeriods_t:
integer
Title:
Contracted Periods
Number of periods the customer has contracted to receive the transaction. -
contractEndDate_t:
string
Title:
Contract End Date
Date that the customer stops receiving all of the products and services on the quote. Used when all services are co-terminated at the quote level. -
contractName_t:
string
Title:
Contract Name
The attribute which captures the name of the CLM contract -
contractStartDate_t:
string
Title:
Contract Start Date
Date that the customer starts to receive all of the products and services on the quote. Used when all services are co-terminated at the quote level. -
contractTypeName_t:
string
Title:
Contract Type Name
The attribute which captures the contract type name of the CLM contract -
coverLetter_t:
string
Title:
Cover Letter
The cover letter to be attached to the proposal document for this transaction. -
createdBy_t:
string
Title:
Created By
The person that created the transaction. -
createdDate_t:
string
Title:
Created Date
The date when the transaction was created. -
createOrderRestResponse:
string
Title:
Create Order Rest Response
This attribute holds the rest response of create order -
currency_t:
object Currency
Title:
Currency
-
currentStepForTesting_tempDisplay_t:
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. -
defaultRequestDate_t:
string
Title:
Default Request Date
The date on which the user requests that fulfillment occur for this transaction. -
fileAttachment_t:
object CmAttachmentAttribute
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute -
freezePriceFlag_t:
boolean
Title:
Freeze Price Flag
Determines whether the external system should use CPQ Pricing or not. If set to true, the external system will use CPQ Pricing. -
fulfillmentStatus_t:
object Fulfillment Status
Title:
Fulfillment Status
-
hasRecurringPricing_t:
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:
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. -
lastPricedDate_t:
string
Title:
Last Priced
The date and time that this transaction was last re-priced. -
lastUpdatedBy_t:
string
Title:
Last Updated By
The person that last updated this transaction. -
lastUpdatedDate_t:
string
Title:
Last Updated
The date and time the transaction was last updated. -
opportunityID_t:
string
Title:
Opportunity ID
The identifier of the parent opportunity. -
opportunityName_t:
string
Title:
Opportunity Name
The name of the parent opportunity. -
opportunityNumber_t:
string
Title:
Opportunity Number
The user or public identifier for the opportunity associated to this transaction. -
oRCL_billingFrequency_t:
object Billing Frequency
Title:
Billing Frequency
-
oRCL_ERP_OrderID_t:
string
Title:
Order ID
The Order ID assigned by the external ERP system to this transaction. -
oRCL_ERP_OrderNumber_t:
string
Title:
Order Number
The order number assigned by the external Order Management and ERP system. -
oRCL_ERP_PartialShipAllowed_t:
boolean
Title:
Partial Ship Allowed
Indicates whether partial shipment of the requested quantity is acceptable to the customer. -
oRCL_SFA_OwnerResourcePartyID_t:
string
Title:
Owner Resource Party ID
The SFA Party ID for the person owning this transaction. -
oRCL_SFA_PrimaryOrgID_t:
string
Title:
Primary Org ID
The primary organization in SFA associated with this transaction or owner. -
oRCL_SFA_Status_t:
string
Title:
Opportunity Win/Loss Status
The current status of this transaction as it relates to SFA. This will differ from the other statuses of the transaction. The mapping of SFA status values to the statuses used in CPQ Cloud is administered in the Status data table. -
oRCL_SFA_SyncTime_t:
string
Title:
Last Opportunity Sync
The date and time on which the transaction was last synced to SFA. -
oRCL_SFA_TransactionID_t:
string
Title:
Partner Transaction ID
The ID generated by SFA to identify this transaction. -
orderDate_t:
string
Title:
Order Date
The date and time the order was placed for fulfillment. -
orderKey_t:
string
Title:
Order Key
Value that uniquely identifies the sales order. -
orderPlacedBy_t:
string
Title:
Ordered By
Records the Current User when the Create Order Action is triggered -
owner_t:
string
Title:
Owner
The person that owns this transaction. -
parent_transaction_id_versionTransaction_t:
string
Title:
Parent Transaction Id[Version Transaction]
This Attribute contains the parent transaction id. -
partialShipAllowedFlag_t:
boolean
Title:
Partial Ship Allowed Flag
Indicates whether partial shipment of the requested quantity is acceptable to the customer. -
paymentTerms_t:
object Payment Terms
Title:
Payment Terms
-
priceExpirationDate_t:
string
Title:
Price Expiration Date
The date the price quote will expire. -
priceScore_t:
integer
Title:
Price Score
The total calculated price score for this transaction, based on an average weighted price score on each line based upon total Contract Value at List price. -
priceType_t:
object Price Type
Title:
Price Type
-
priceWithinPolicy_t:
boolean
Title:
Price Within Policy
Indicates whether the prices in this transaction are all within their discount authority. -
primaryFlag_t:
boolean
Title:
Primary Flag
Indicates that this quote is used as the basis for updating revenues on an associated opportunity. -
proposalExists_t:
boolean
Title:
Proposal Exists
Indicates whether the transaction has Proposal Document that can be viewed within the CRM or other integrated system. -
purchaseOrderNumber_t:
string
Title:
PO Number
The purchase order number provided by the customer. -
rejectExplanation_t:
string
Title:
Reject Explanation
A detailed, free-form explanation of why the customer rejected the deal. -
rejectReason_t:
object Reject Reason
Title:
Reject Reason
-
renewalErrorEmailAddress_t:
string
Title:
Renewal Error Email Address
The email address to be used to report an error in the automated renewal process. A distribution list email should be used if a department or group is to be notified. -
renewalProcess_t:
object Renewal Process
Title:
Renewal Process
-
renewalProcessUsed_t:
object Renewal Process Used
Title:
Renewal Process Used
-
renewDraftSubscriptionNumber_t:
string
Title:
Renew Draft Subscription Number
Subscription management contract ID for the draft subscription used in the renewal process. -
requireApprovalIfChecked_temporary_t:
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:
object Sales Channel
Title:
Sales Channel
-
status_t:
object Status
Title:
Status
-
subscription_Status_t:
string
Title:
Subscription Status
The status of the subscription order -
subscriptionProfileId_t:
string
Title:
SubscriptionProfileId
Customer subscription profile identifier to be used in subscription management to specify subscription contract preferences. -
totalAnnualCostAmount_t:
object Annual Cost
Title:
Annual Cost
The total of recurring extended costs each year for the transaction. -
TotalAnnualDiscount_t:
object Annual Contract Discount
Title:
Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction. -
totalAnnualMarginAmount_t:
object Annual Margin
Title:
Annual Margin
The total of recurring extended margins each year for the transaction. -
totalAnnualValue_t:
object Annual Contract Value(Net)
Title:
Annual Contract Value(Net)
The total value of recurring charges each year. -
totalContractCostAmount_t:
object Total Contract Cost
Title:
Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs. -
totalContractDiscount_t:
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. -
totalContractListValue_t:
object Total Contract Value (List)
Title:
Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List). -
totalContractMarginAmount_t:
object Total Contract Margin
Title:
Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values. -
totalContractValue_t:
object Total Contract Value (Net)
Title:
Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. -
totalMonthlyCostAmount_t:
object Total Monthly Cost
Title:
Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month. -
totalMonthlyDiscount_t:
object Total Discount Per Month
Title:
Total Discount Per Month
The total of discounts off monthly recurring charges. -
totalMonthlyListAmount_t:
object Total (List) Per Month
Title:
Total (List) Per Month
The total of all monthly recurring list amounts on the lines. -
totalMonthlyMarginAmount_t:
object Total Monthly Margin
Title:
Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction. -
totalMonthlyNetAmount_t:
object Total (Net) Per Month
Title:
Total (Net) Per Month
The total of all monthly recurring net amounts on the lines. -
totalMonthlyUsageRev_t:
object Total MUR (Net)
Title:
Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction. -
totalOneTimeCostAmount_t:
object Total One-Time Cost
Title:
Total One-Time Cost
The total of extended costs for all one-time charges for the transaction. -
totalOneTimeDiscount_t:
object Total Discount
Title:
Total Discount
The total of all extended discount amounts for one time??pricing/charges. -
totalOneTimeListAmount_t:
object Total (List)
Title:
Total (List)
The total of all one-time charges on the lines. -
totalOneTimeMarginAmount_t:
object Total One-Time Margin
Title:
Total One-Time Margin
The total of extended margins for all one-time charges for the transaction. -
totalOneTimeNetAmount_t:
object Total (Net)
Title:
Total (Net)
The total one time net charge. -
totalRecurRevenue_t:
object Total Recurring Revenue (Net)
Title:
Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction. -
totalUsageRevenue_t:
object Total Usage Revenue (Net)
Title:
Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction. -
transactionDescription_t:
string
Title:
Transaction Description
Description of the CPQ Transaction. -
transactionID_t:
string
Title:
Transaction Number
The number or public unique identifier of the transaction. -
transactionLine:
object TransactionLine-collection
-
transactionMarginPercent_t:
number
Title:
Total Transaction Margin %
The percentage of the total list price for which this transaction 's margin accounts. -
transactionName_t:
string
Title:
Transaction Name
Attribute which captures the user entered Transaction Name -
transactionSourceSystem_t:
string
Title:
Transaction Source System
The code used to identify CPQ as the source for this transaction. -
transactionTotalDiscountPercent_t:
number
Title:
Total Discount %
The percentage of the Total Transaction (List) that is discounted off of the transaction. One-time and recurring pricing for the specified contract duration are included. -
triggerUpdateAssetForLineStatus_t:
string
Title:
Trigger Update Asset for Line Status
List of line.status_l values which indicate that line has finished processing on FOM and is ready to move to asset in CPQ(pending other lines' s status within same root). -
userKey_t:
string
Title:
Transaction Version User Key
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:
string
Title:
Version Number
This Attribute Lists the Version Number for a document. -
version_t:
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). -
winLossStatus_t:
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 : _currency_pref
Type:
object
Title:
Show Source
_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 : Customer Country
Type:
object
Title:
Show Source
Customer Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer State
Type:
object
Title:
Show Source
Customer State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : CmAttachmentAttribute
Type:
object
Title:
CmAttachmentAttribute
Complex type that describes commerce attachment attribute
Show Source
-
fileId:
string
Identifier of permanent or temporary record holding file content
-
fileLocation:
string
URI to perform download / upload operations; GET can be performed only when isFileSaved is true
-
fileName:
string
Attached file name
-
fileType:
string
MIME type of attached file content
-
isFileSaved:
boolean
Indicates that file is saved in permanent storage location or just uploaded in temporary location
Nested Schema : eSignature Status[eSignature Attribute Set]
Type:
object
Title:
Show Source
eSignature Status[eSignature Attribute Set]
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : eSignature Status[esig Test]
Type:
object
Title:
Show Source
eSignature Status[esig Test]
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Invoice To Country
Type:
object
Title:
Show Source
Invoice To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Invoice To State
Type:
object
Title:
Show Source
Invoice To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
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 : Revenue Category
Type:
object
Title:
Show Source
Revenue Category
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Assigned To
Type:
object
Title:
Show Source
Assigned To
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Bill To Country
Type:
object
Title:
Show Source
Bill To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Bill To State
Type:
object
Title:
Show Source
Bill To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer Status
Type:
object
Title:
Show Source
Customer Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Customer Visibility Identifier
Type:
object
Title:
Show Source
Customer Visibility Identifier
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Source Of Transaction
Type:
object
Title:
Show Source
Source Of Transaction
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Ship To Country
Type:
object
Title:
Show Source
Ship To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Ship To State
Type:
object
Title:
Show Source
Ship To State
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sold To Country
Type:
object
Title:
Show Source
Sold To Country
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Sold To State
Type:
object
Title:
Show Source
Sold To State
-
displayValue:
string
Title:
displayValue
-
value:
string
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 : Transaction Total (Net)
Type:
object
Title:
Transaction Total (Net)
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Account Type
Type:
object
Title:
Show Source
Account Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Account AddressType
Type:
object
Title:
Show Source
Account AddressType
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Annual Contract Value (List)
Type:
object
Title:
Annual Contract Value (List)
The total of contract extended values at list price within the first year, including only recurring pricing.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Approval History[Submit]
Type:
array
Title:
Approval History[Submit]
This attribute records approval history of a transaction.If a reason is reset, it is erased from the approval history.
Show Source
-
Array of:
object Approval History
Title:
Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Approval Status[Submit]
Type:
array
Title:
Approval Status[Submit]
This attribute lists all currently pending active approvals for a transaction.
Show Source
-
Array of:
object Approval Reject Status
Title:
Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Nested Schema : My Approval[Submit]
Type:
array
Title:
My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
-
Array of:
object Approval Reject Icon
Title:
Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Nested Schema : Cancel Reason
Type:
object
Title:
Show Source
Cancel Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Contact Type
Type:
object
Title:
Show Source
Contact Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Currency
Type:
object
Title:
Show Source
Currency
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Fulfillment Status
Type:
object
Title:
Show Source
Fulfillment Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Billing Frequency
Type:
object
Title:
Show Source
Billing Frequency
-
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 : Price Type
Type:
object
Title:
Show Source
Price Type
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Reject Reason
Type:
object
Title:
Show Source
Reject Reason
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Renewal Process
Type:
object
Title:
Show Source
Renewal Process
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
Nested Schema : Renewal Process Used
Type:
object
Title:
Show Source
Renewal Process Used
-
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 : Annual Cost
Type:
object
Title:
Annual Cost
The total of recurring extended costs each year for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Margin
Type:
object
Title:
Annual Margin
The total of recurring extended margins each year for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Annual Contract Value(Net)
Type:
object
Title:
Annual Contract Value(Net)
The total value of recurring charges each year.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Cost
Type:
object
Title:
Total Contract Cost
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Value (List)
Type:
object
Title:
Total Contract Value (List)
The total of all contract extended values at list price for this transaction over the duration of the contract, including all one-time and recurring pricing. Equal to the Transaction Total (List).
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Margin
Type:
object
Title:
Total Contract Margin
The total of all contract extended margins for this transaction over the duration of the contract, including all one - time and recurring values.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Contract Value (Net)
Type:
object
Title:
Total Contract Value (Net)
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Monthly Cost
Type:
object
Title:
Total Monthly Cost
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
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:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (List) Per Month
Type:
object
Title:
Total (List) Per Month
The total of all monthly recurring list amounts on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Monthly Margin
Type:
object
Title:
Total Monthly Margin
The total of extended margins for all monthly recurring charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (Net) Per Month
Type:
object
Title:
Total (Net) Per Month
The total of all monthly recurring net amounts on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total MUR (Net)
Type:
object
Title:
Total MUR (Net)
The total of all monthly usage revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total One-Time Cost
Type:
object
Title:
Total One-Time Cost
The total of extended costs for all one-time charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Discount
Type:
object
Title:
Total Discount
The total of all extended discount amounts for one time??pricing/charges.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (List)
Type:
object
Title:
Total (List)
The total of all one-time charges on the lines.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total One-Time Margin
Type:
object
Title:
Total One-Time Margin
The total of extended margins for all one-time charges for the transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total (Net)
Type:
object
Title:
Total (Net)
The total one time net charge.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Recurring Revenue (Net)
Type:
object
Title:
Total Recurring Revenue (Net)
The total recurring revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : Total Usage Revenue (Net)
Type:
object
Title:
Total Usage Revenue (Net)
The total usage revenues net of all discounts for this transaction.
Show Source
-
currency:
string
Title:
currency
-
value:
number
Title:
value
Nested Schema : TransactionLine-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 : Win/Loss Status
Type:
object
Title:
Show Source
Win/Loss Status
-
displayValue:
string
Title:
displayValue
-
value:
string
Title:
value
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 : Approval History
Type:
object
Title:
Approval History
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
-
actionPerformed:
string
Title:
actionPerformed
String value that specifies actionPerformed. -
performDate:
string
Title:
performDate
Date value that specifies performDate. -
performerComment:
string
Title:
performerComment
String value that specifies performerComment. -
performerCompany:
string
Title:
performerCompany
String value that specifies performerCompany. -
performerName:
string
Title:
performerName
String value that specifies performerName. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName. -
revisionNumber:
integer
Title:
revisionNumber
Integer value that specifies revisionNumber.
Nested Schema : Approval Reject Status
Type:
object
Title:
Approval Reject Status
This attribute lists all approval and reject status details for current logged in user.
Show Source
-
approverNames:
array approverNames
Title:
approverNames
String value that specifies approverNames. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName.
Nested Schema : approverNames
Type:
array
Title:
approverNames
String value that specifies approverNames.
Show Source
-
Array of:
string
String value of an element 's unique identifier.
Nested Schema : Approval Reject Icon
Type:
object
Title:
Approval Reject Icon
This attribute lists all approval and reject icon details for current logged in user.
Show Source
-
approvalId:
integer
Title:
approvalId
Integer value that specifies approvalId. -
approveActionId:
integer
Title:
approveActionId
Integer value that specifies approveActionId. -
approveActionLabel:
string
Title:
approveActionLabel
String value that specifies approveActionLabel. -
approveIcon:
string
Title:
approveIcon
String value that specifies approveIcon. -
reasonName:
string
Title:
reasonName
String value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarName
String value that specifies reasonVarName. -
rejectActionId:
integer
Title:
rejectActionId
Integer value that specifies rejectActionId. -
rejectIcon:
string
Title:
rejectIcon
String value that specifies rejectIcon. -
rejectIconLabel:
string
Title:
rejectIconLabel
String value that specifies approveActionLabel.
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 Transaction Line
Title:
Transaction Line
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 : 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 : 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 : 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 : 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 : items
Type:
Show Source
array
-
Array of:
object Available Rate Plan Set
Title:
Available Rate Plan Set
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 : 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 revise the transaction submitted for approval 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/1801963/actions/revise_submit_t
Response Body Sample
{ "reason_var_name": "alwaysTrueReason", "documents": { ..."approval_history_submit_t": [{ "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "Requesting quote for approval", "actionPerformed": "Submit" }, { "performDate": "07/18/2017", "performerName": "superuser", "revisionNumber": 1, "performerCompany": "slc09vel", "reasonName": "", "reasonVarName": "", "performerComment": "", "actionPerformed": "Revised" } ], "approval_status_submit_t": "", "_step_var_name": "savedTransaction", "_submitted_by_submit_t": "superuser", "approve_reject_icon_submit_t": "", "approval_revision_submit_t": 2, ... } }