Get Transaction
get
/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}
Use this endpoint to retrieve the specified transaction.
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.
-
Stage(required): string
The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
-
id(required): integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Query Parameters
-
excludeFieldTypes: string
Exclude specified field types.
-
expand: string
Allows expansion of relationships.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Transaction
Type:
objectTitle:
Show Source
Transaction-
_approve_link:
string
Title:
Approve LinkLinks 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 IdThis 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 AddressFirst 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 2Second 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 CityCity 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 NameCompany 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 2Secondary 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 EmailEmail 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 FaxFax 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 NameFirst 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 NameLast 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 PhonePhone 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 ZipZip 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 NumberUnique 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:
CmAttachmentAttributeComplex 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] -
_id:
integer
Title:
_id -
_invoiceTo_t_address:
string
Title:
Invoice To AddressFirst Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_address_2:
string
Title:
Invoice To Address 2Second Line for the Address of the organization being billed for this transaction. -
_invoiceTo_t_city:
string
Title:
Invoice To CityCity of the organization being billed for this transaction. -
_invoiceTo_t_company_name:
string
Title:
Invoice To Company NameCompany Name of the organization being billed for this transaction. -
_invoiceTo_t_company_name_2:
string
Title:
Invoice To Company Name 2Secondary 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 EmailEmail Address of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_fax:
string
Title:
Invoice To FaxFax Number for the contact person for the organization being billed for this transaction. -
_invoiceTo_t_first_name:
string
Title:
Invoice To First NameFirst Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_last_name:
string
Title:
Invoice To Last NameLast Name of the contact person for the organization being billed for this transaction. -
_invoiceTo_t_phone:
string
Title:
Invoice To PhonePhone 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 ZipZip 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_nameFirst name of User who locked the trasnaction -
_locked_by_user_last_name:
string
Title:
_locked_by_user_last_nameLast Name of User who locked the trasnaction -
_locked_by_user_login:
string
Title:
_locked_by_user_loginLogin of User who locked the trasnaction -
_locked_time:
string
Title:
_locked_time -
_partner_price_book_id:
string
Title:
Partner Price Book IdPartner 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 AttributeComposite 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 AttributeComposite attribute is used to display one or more fields belonging to a family of attributes. -
_price_book_desc:
string
Title:
Price Book DescriptionPrice Book Description -
_price_book_name:
string
Title:
Price Book NamePrice Book Name -
_price_book_var_name:
string
Title:
Price Book Variable NameVariable 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 LinkLinks 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 NumberContact number of the account. -
_s_accountIntegrationResponse_t:
string
Title:
Account Integration ResponseHolds the response of TCA account integration. -
_s_accountPartyId_t:
string
Title:
Account PartyIdThe CDM integration provides the value for this field based on the Customer Company Name -
_s_accountPartyNumber_t:
string
Title:
Account Party NumberIdentifier 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 AddressFirst Line of the Address of the organization where this transaction will be billed. -
_s_billTo_t_address_2:
string
Title:
Bill To Address 2Second Line of the Address of the organization where this transaction will be billed. -
_s_billTo_t_city:
string
Title:
Bill To CityCity of the organization where this transaction will be billed. -
_s_billTo_t_company_name:
string
Title:
Bill To Company NameCompany Name of the organization where this transaction will be billed. -
_s_billTo_t_company_name_2:
string
Title:
Bill To Company Name 2Secondary Company Name of the organization where this transaction will be billed. -
_s_billTo_t_country:
object Bill To Country
Title:
Bill To Country -
_s_billTo_t_email:
string
Title:
Bill To EmailEmail Address for the contact person for the organization to which this order will be billed. -
_s_billTo_t_fax:
string
Title:
Bill To FaxFax Number for the contact person for the organization to which this order will be billed. -
_s_billTo_t_first_name:
string
Title:
Bill To First NameFirst Name of the contact person for the organization to which this order will be billed. -
_s_billTo_t_last_name:
string
Title:
Bill To Last NameLast Name of the contact person for the organization to which this order will be billed. -
_s_billTo_t_phone:
string
Title:
Bill To PhonePhone Number for the contact person for the organization to which this order will be billed. -
_s_billTo_t_state:
object Bill To State
Title:
Bill To State -
_s_billTo_t_zip:
string
Title:
Bill To ZipZip Code of the organization where this transaction will be billed. -
_s_billToCustomerAccountID_t:
string
Title:
Bill to Customer Account IdTCA 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 NameTCA account integration provides value from BillingAccountName to this field based on Customer Id and Business Unit ID -
_s_contactNumber_t:
string
Title:
Contact NumberContact number of the contact. -
_s_contactPartyNumber_t:
string
Title:
Contact Party NumberIdentifier for the type of the contact under the party. -
_s_contractID_t:
string
Title:
Contract IDThe identifier of the CLM contract -
_s_contractTypeID_t:
string
Title:
Contract Type IDThe identifier for the CLM contract Type. -
_s_customerPartySiteID_t:
string
Title:
Customer Party Site IDThe 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_discountGuidanceCeiling_t:
number
Title:
Discount Guidance CeilingUpper bound of the discount guidance. -
_s_discountGuidanceFloor_t:
number
Title:
Discount Guidance FloorLower bound of the discount guidance. -
_s_discountGuidanceMax_t:
number
Title:
Discount Guidance MaxMax of the discount guidance. -
_s_discountGuidanceMeterGauge_t:
string
Title:
Discount Guidance Meter GaugeHold discount guidance graph. -
_s_hostCompanyFullName_t:
string
Title:
Host Company Full NameFull company name of current user's company. -
_s_html_main_price_optimization_t:
string
Title:
html_main_price_optimizationHold Win Probability with Optimization graph. Populated when 'Total Discount %', Customer Segment and Total Contract Value (Net) are populated and 'Calculate WP OP Revenue' action is triggered. -
_s_html_main_scatterplot_t:
string
Title:
html_main_scatterplotHold header lever scatter plot graph. -
_s_html_main_timeseries_t:
string
Title:
html_main_timeseriesHold Time Series graph. -
_s_invoiceToPartySiteID_t:
string
Title:
Invoice To Party Site IDThe ID for the Party Site or Address of the Invoice To party. -
_s_isLatestProposal_t:
boolean
Title:
Is Latest ProposalThe flag to identify if the proposal generated is based on the latest Quote data. Generate Proposal action sets this flag to true and Revise Quote action resets this flag to false. -
_s_isPublished_t:
boolean
Title:
Is PublishedIndicates whether this quote was published to customer. This flag is set to true when the quote is published for the first time. -
_s_optimalPrimaryDriver_t:
number
Title:
Optimal Primary Driver (Discount%)Optimal Discount% returned from Price Optimization analytic 'Optimized Discount%'. -
_s_optimalTargetValue_t:
number
Title:
Optimal Target ValueOptimal Target Value returned from the Price Optimization based analytic 'Optimized Discount%'. -
_s_optimalWinProbability_t:
number
Title:
Optimal Win ProbabilityOptimal Win Probability value returned from price optimization analytic 'Optimized Discount%'. -
_s_priceScoreListBased_t:
integer
Title:
Price Score List BasedPrice score for the transaction using List Based calculation method. In order to see a value in this, please add some lines and set the 'Line Item Grid Columns' to 'PriceScoreSet'. -
_s_priceScoreMarginBased_t:
integer
Title:
Price Score Margin BasedPrice score for the transaction using Margin Based calculation method. In order to see a value in this, please add some lines and set the 'Line Item Grid Columns' to 'PriceScoreSet'. -
_s_priceScoreSimpleMarginListPrice_t:
integer
Title:
Price Score Simple Margin Based (List Price Basis)Price score calculation using Simple Margin Based method and List Price as Basis attribute. In order to see a value in this, please add some lines and set the 'Line Item Grid Columns' to 'PriceScoreSet'. -
_s_priceScoreSimpleMarginNetPrice_t:
integer
Title:
Price Score Simple Margin Based (Net Price Basis)Price score calculation using Simple Margin Based method and Net Price as Basis attribute. In order to see a value in this, please add some lines and set the 'Line Item Grid Columns' to 'PriceScoreSet'. -
_s_priceScoreSimpleMarginUnitCost_t:
integer
Title:
Price Score Simple Margin Based (Unit Cost Basis)Price score calculation using Simple Margin Based method and Unit Cost as Basis attribute. In order to see a value in this, please add some lines and set the 'Line Item Grid Columns' to 'PriceScoreSet'. -
_s_quoteForAgreement_t:
boolean
Title:
Quote for AgreementIndicates whether the transaction is used as a Sales Agreement -
_s_shipToPartyID_t:
string
Title:
Ship To Party IDThe 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 IDThe ID for the Party Site or Address of the Ship To party. -
_s_skipSellerReview_t:
boolean
Title:
Skip Seller ReviewThe flag to identify if seller or sales rep should be involved in the Quote flows. This flag can be set to true if seller's involvement is not desired. -
_s_soldToCustomerAccountID_t:
string
Title:
Sold To Customer Account IDThe 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 IDThe 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 NameTCA 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 IDThe ID for the Party Site or Address of the Sold To party. -
_s_subscriptionId_t:
string
Title:
Subscription IDThe identifier of the subscription contract. -
_s_transactionComments_t:
object Transaction_s_transactionComments_t-collection
-
_s_transactionSource_t:
object Source Of Transaction
Title:
Source Of Transaction -
_s_useTransactionForAnalytics_t:
boolean
Title:
Use Transaction For Analytics?This is used as a filter attribute for analytics. When set to True, values in this transaction will be used by analytics. -
_s_winProbability_t:
number
Title:
Win ProbabilityWin Probability value returned from the WP analytic named 'Win Probability'. -
_s_winProbNoOptimization_t:
string
Title:
WinProbability Without OptimizationHold winprobability without Optimization graph. -
_s_winProbRevPrediction_t:
number
Title:
Win Probability Net Revenue Value PredictionWin Probability Net Revenue Value Predicted by the Price Optimization Analytic 'Optimized Discount%'. -
_shipTo_t_address:
string
Title:
Ship To AddressFirst Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_address_2:
string
Title:
Ship To Address 2Second Line of the Address of the organization where this transaction will be shipped. -
_shipTo_t_city:
string
Title:
Ship To CityCity of the organization where this transaction will be shipped. -
_shipTo_t_company_name:
string
Title:
Ship To Company NameCompany Name of the organization where this transaction will be shipped. -
_shipTo_t_company_name_2:
string
Title:
Ship To Company Name 2Secondary 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 EmailEmail Address for the contact person for the organization to which this order will be shipped. -
_shipTo_t_fax:
string
Title:
Ship To FaxFax Number for the contact person for the organization to which this order will be shipped. -
_shipTo_t_first_name:
string
Title:
Ship To First NameFirst Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_last_name:
string
Title:
Ship To Last NameLast Name of the contact person for the organization to which this order will be shipped. -
_shipTo_t_phone:
string
Title:
Ship To PhonePhone 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 ZipZip Code of the organization where this transaction will be shipped. -
_soldTo_t_address:
string
Title:
Sold To AddressFirst 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 2Second 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 CityCity 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 NameCompany 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 2Secondary 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 EmailEmail 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 FaxFax 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 NameFirst 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 NameLast 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 PhonePhone 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 ZipZip Code of the buying organization for this transation linked from the ERP System. This is functionally eqivalent to the Customer contact information. -
_stage:
object Stage
Title:
Stage -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_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 -
_tax_isTaxInclusive_t:
boolean
Title:
Is Tax InclusiveFlag to identify whether taxes are calculated in the prices or not. -
_tax_isTaxPresent_t:
boolean
Title:
Is Tax PresentFlag to identify if the tax information is present. -
_tax_taxAmount_t:
object Tax Amount
Title:
Tax AmountTotal Tax Amount for the Quote. -
_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 AddressElementAttribute1Account AddressElementAttribute1 -
accountAddressElementAttribute2_t:
string
Title:
Account AddressElementAttribute2Account AddressElementAttribute2 -
accountAddressElementAttribute3_t:
string
Title:
Account AddressElementAttribute3Account AddressElementAttribute3 -
accountAddressElementAttribute4_t:
string
Title:
Account AddressElementAttribute4Account AddressElementAttribute4 -
accountAddressElementAttribute5_t:
string
Title:
Account AddressElementAttribute5Account AddressElementAttribute5 -
accountAddressLine1_t:
string
Title:
Account AddressLine1First line of the account address -
accountAddressLine2_t:
string
Title:
Account AddressLine2Second line of the account address -
accountAddressLine3_t:
string
Title:
Account AddressLine3Third line of the account address -
accountAddressLine4_t:
string
Title:
Account AddressLine4Fourth line of the account address -
accountCity_t:
string
Title:
Account CityCity of the account -
accountCountry_t:
string
Title:
Account CountryCountry of the account -
accountEmailAddress_t:
string
Title:
Account EmailAddressEmail address of the account -
accountFirstName_t:
string
Title:
Account First NameFirst Name of the Account Contact -
accountLastName_t:
string
Title:
Account Last NameLast Name of the Account Contact -
accountMiddleName_t:
string
Title:
Account Middle NameMiddle Name of the Account Contact -
accountName_t:
string
Title:
Account NameThe attribute which captures the name of the Account -
accountNameSuffix_t:
string
Title:
Account Name SuffixName suffix of the Account contact -
accountPostalCode_t:
integer
Title:
Account PostalCodePostal Code of the account -
accountProvince_t:
string
Title:
Account ProvinceProvince of the account -
accountState_t:
string
Title:
Account StateState of the account -
accountType_t:
object Account Type
Title:
Account Type -
accountUniqueName_t:
string
Title:
Account Unique NameUnique 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 IdCDM integration will provide value to this field based on Customer company name -
bs_id:
string
Title:
Transaction Internal IDCurrent Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. -
businessUnitId_t:
string
Title:
Business Unit IDCustomer business unit identifier. -
businessUnitName_t:
string
Title:
Business Unit NameCustomer business unit name. -
cancelExplanation_t:
string
Title:
Cancel ExplanationA 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 AddressElementAttribute1Contact AddressElementAttribute1 -
contactAddressElementAttribute2_t:
string
Title:
Contact AddressElementAttribute2Contact AddressElementAttribute2 -
contactAddressElementAttribute3_t:
string
Title:
Contact AddressElementAttribute3Contact AddressElementAttribute3 -
contactAddressElementAttribute4_t:
string
Title:
Contact AddressElementAttribute4Contact AddressElementAttribute4 -
contactAddressElementAttribute5_t:
string
Title:
Contact AddressElementAttribute5Contact AddressElementAttribute5 -
contactAddressLine1_t:
string
Title:
Contact AddressLine1First line of the contact address -
contactAddressLine2_t:
string
Title:
Contact AddressLine2Second line of the contact address -
contactAddressLine3_t:
string
Title:
Contact AddressLine3Third line of the contact address -
contactAddressLine4_t:
string
Title:
Contact AddressLine4Fourth line of the contact address -
contactCity_t:
string
Title:
Contact CityCity of the contact -
contactCountry_t:
string
Title:
Contact CountryCountry of the contact -
contactEmailAddress_t:
string
Title:
Contact Email AddressEmail address of the contact -
contactFirstName_t:
string
Title:
Contact First NameFirst Name of the Contact -
contactLastName_t:
string
Title:
Contact Last NameLast Name of the Contact -
contactMiddleName_t:
string
Title:
Contact Middle NameMiddle Name of the Contact -
contactName_t:
string
Title:
Contact NameThe attribute which captures the Contact Name of the Account -
contactNameSuffix_t:
string
Title:
Contact Name SuffixName suffix of the contact -
contactPostalCode_t:
string
Title:
Contact PostalCodePostal Code of the contact -
contactProvince_t:
string
Title:
Contact ProvinceProvince of the contact -
contactState_t:
string
Title:
Contact StateState of the contact -
contactType_t:
object Contact Type
Title:
Contact Type -
contactUniqueName_t:
string
Title:
Contact Unique NameUnique identifier for the Account contact -
contractedPeriods_t:
integer
Title:
Contracted PeriodsNumber of periods the customer has contracted to receive the transaction. -
contractEndDate_t:
string
Title:
Contract End DateDate 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 NameThe attribute which captures the name of the CLM contract -
contractStartDate_t:
string
Title:
Contract Start DateDate 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 NameThe attribute which captures the contract type name of the CLM contract -
coverLetter_t:
string
Title:
Cover LetterThe cover letter to be attached to the proposal document for this transaction. -
createdBy_t:
string
Title:
Created ByThe person that created the transaction. -
createdDate_t:
string
Title:
Created DateThe date when the transaction was created. -
createOrderRestResponse:
string
Title:
Create Order Rest ResponseThis attribute holds the rest response of create order -
currency_t:
object Currency
Title:
Currency -
currentStepForTesting_tempDisplay_t:
string
Title:
Current StepThis 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 DateThe date on which the user requests that fulfillment occur for this transaction. -
fileAttachment_t:
object CmAttachmentAttribute
Title:
CmAttachmentAttributeComplex type that describes commerce attachment attribute -
freezePriceFlag_t:
boolean
Title:
Freeze Price FlagDetermines 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 PricingIndicates 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 IDThe 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 PricedThe date and time that this transaction was last re-priced. -
lastUpdatedBy_t:
string
Title:
Last Updated ByThe person that last updated this transaction. -
lastUpdatedDate_t:
string
Title:
Last UpdatedThe date and time the transaction was last updated. -
opportunityID_t:
string
Title:
Opportunity IDThe identifier of the parent opportunity. -
opportunityName_t:
string
Title:
Opportunity NameThe name of the parent opportunity. -
opportunityNumber_t:
string
Title:
Opportunity NumberThe 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 IDThe Order ID assigned by the external ERP system to this transaction. -
oRCL_ERP_OrderNumber_t:
string
Title:
Order NumberThe order number assigned by the external Order Management and ERP system. -
oRCL_ERP_PartialShipAllowed_t:
boolean
Title:
Partial Ship AllowedIndicates whether partial shipment of the requested quantity is acceptable to the customer. -
oRCL_SFA_OwnerResourcePartyID_t:
string
Title:
Owner Resource Party IDThe SFA Party ID for the person owning this transaction. -
oRCL_SFA_PrimaryOrgID_t:
string
Title:
Primary Org IDThe primary organization in SFA associated with this transaction or owner. -
oRCL_SFA_Status_t:
string
Title:
Opportunity Win/Loss StatusThe 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 SyncThe date and time on which the transaction was last synced to SFA. -
oRCL_SFA_TransactionID_t:
string
Title:
Partner Transaction IDThe ID generated by SFA to identify this transaction. -
orderDate_t:
string
Title:
Order DateThe date and time the order was placed for fulfillment. -
orderKey_t:
string
Title:
Order KeyValue that uniquely identifies the sales order. -
orderPlacedBy_t:
string
Title:
Ordered ByRecords the Current User when the Create Order Action is triggered -
owner_t:
string
Title:
OwnerThe 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 FlagIndicates 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 DateThe date the price quote will expire. -
priceScore_t:
integer
Title:
Price ScoreThe 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 PolicyIndicates whether the prices in this transaction are all within their discount authority. -
primaryFlag_t:
boolean
Title:
Primary FlagIndicates that this quote is used as the basis for updating revenues on an associated opportunity. -
proposalExists_t:
boolean
Title:
Proposal ExistsIndicates whether the transaction has Proposal Document that can be viewed within the CRM or other integrated system. -
purchaseOrderNumber_t:
string
Title:
PO NumberThe purchase order number provided by the customer. -
rejectExplanation_t:
string
Title:
Reject ExplanationA 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 AddressThe 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 NumberSubscription management contract ID for the draft subscription used in the renewal process. -
requireApprovalIfChecked_temporary_t:
boolean
Title:
Require Approval If CheckedThis 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 StatusThe status of the subscription order -
subscriptionProfileId_t:
string
Title:
SubscriptionProfileIdCustomer subscription profile identifier to be used in subscription management to specify subscription contract preferences. -
totalAnnualCostAmount_t:
object Annual Cost
Title:
Annual CostThe total of recurring extended costs each year for the transaction. -
TotalAnnualDiscount_t:
object Annual Contract Discount
Title:
Annual Contract DiscountThe total value each year of the discounts on recurring charges for the transaction. -
totalAnnualMarginAmount_t:
object Annual Margin
Title:
Annual MarginThe 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 CostThe 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 DiscountThe 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 MarginThe 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 CostThe 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 MonthThe total of discounts off monthly recurring charges. -
totalMonthlyListAmount_t:
object Total (List) Per Month
Title:
Total (List) Per MonthThe total of all monthly recurring list amounts on the lines. -
totalMonthlyMarginAmount_t:
object Total Monthly Margin
Title:
Total Monthly MarginThe total of extended margins for all monthly recurring charges for the transaction. -
totalMonthlyNetAmount_t:
object Total (Net) Per Month
Title:
Total (Net) Per MonthThe 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 CostThe total of extended costs for all one-time charges for the transaction. -
totalOneTimeDiscount_t:
object Total Discount
Title:
Total DiscountThe 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 MarginThe 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 DescriptionDescription of the CPQ Transaction. -
transactionID_t:
string
Title:
Transaction NumberThe 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 NameAttribute which captures the user entered Transaction Name -
transactionSourceSystem_t:
string
Title:
Transaction Source SystemThe 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 StatusList 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 KeyThe 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 NumberThis Attribute Lists the Version Number for a document. -
version_t:
integer
Title:
VersionThe 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 : _currency_pref
Type:
objectTitle:
Show Source
_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Nested Schema : Customer Country
Type:
objectTitle:
Show Source
Customer Country-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Customer State
Type:
objectTitle:
Show Source
Customer State-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : CmAttachmentAttribute
Type:
objectTitle:
CmAttachmentAttributeComplex 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:
objectTitle:
Show Source
eSignature Status[eSignature Attribute Set]-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Invoice To Country
Type:
objectTitle:
Show Source
Invoice To Country-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Invoice To State
Type:
objectTitle:
Show Source
Invoice To State-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Commerce Composite Attribute
Type:
objectTitle:
Commerce Composite AttributeComposite attribute is used to display one or more fields belonging to a family of attributes.
Show Source
-
value:
object Value
Title:
ValueComposite attribute value
Nested Schema : Revenue Category
Type:
objectTitle:
Show Source
Revenue Category-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Assigned To
Type:
objectTitle:
Show Source
Assigned To-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Bill To Country
Type:
objectTitle:
Show Source
Bill To Country-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Bill To State
Type:
objectTitle:
Show Source
Bill To State-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Customer Status
Type:
objectTitle:
Show Source
Customer Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Customer Visibility Identifier
Type:
objectTitle:
Show Source
Customer Visibility Identifier-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Transaction_s_transactionComments_t-collection
Type:
Show Source
object-
_state:
object state
Title:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Source Of Transaction
Type:
objectTitle:
Show Source
Source Of Transaction-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Ship To Country
Type:
objectTitle:
Show Source
Ship To Country-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Ship To State
Type:
objectTitle:
Show Source
Ship To State-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Sold To Country
Type:
objectTitle:
Show Source
Sold To Country-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Sold To State
Type:
objectTitle:
Show Source
Sold To State-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Stage
Type:
objectTitle:
Show Source
Stage-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : state
Type:
objectTitle:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
-
actions:
object Actions
Title:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action. -
attributes:
object Attributes
Title:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute. -
deletable:
boolean
Title:
DeletableBoolean value that specifies whether the row can be deleted. -
focus:
object Focused Users
Title:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the row itself. -
hasWarning:
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the row itself. - hidden: boolean
-
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
updatable:
boolean
Title:
UpdatableBoolean value that specifies whether the row can be updated.
Nested Schema : Tax Amount
Type:
objectTitle:
Tax AmountTotal Tax Amount for the Quote.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Transaction Total (Net)
Type:
objectTitle:
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:
objectTitle:
Show Source
Account Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Account AddressType
Type:
objectTitle:
Show Source
Account AddressType-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Annual Contract Value (List)
Type:
objectTitle:
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:
arrayTitle:
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 HistoryThis attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Approval Status[Submit]
Type:
arrayTitle:
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 StatusThis attribute lists all approval and reject status details for current logged in user.
Nested Schema : My Approval[Submit]
Type:
arrayTitle:
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 IconThis attribute lists all approval and reject icon details for current logged in user.
Nested Schema : Cancel Reason
Type:
objectTitle:
Show Source
Cancel Reason-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Contact Type
Type:
objectTitle:
Show Source
Contact Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Currency
Type:
objectTitle:
Show Source
Currency-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Fulfillment Status
Type:
objectTitle:
Show Source
Fulfillment Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Billing Frequency
Type:
objectTitle:
Show Source
Billing Frequency-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Payment Terms
Type:
objectTitle:
Show Source
Payment Terms-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Reject Reason
Type:
objectTitle:
Show Source
Reject Reason-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Renewal Process
Type:
objectTitle:
Show Source
Renewal Process-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Renewal Process Used
Type:
objectTitle:
Show Source
Renewal Process Used-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Sales Channel
Type:
objectTitle:
Show Source
Sales Channel-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Status
Type:
objectTitle:
Show Source
Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Annual Cost
Type:
objectTitle:
Annual CostThe 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:
objectTitle:
Annual Contract DiscountThe 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:
objectTitle:
Annual MarginThe 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:
objectTitle:
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:
objectTitle:
Total Contract CostThe 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:
objectTitle:
Total Contract DiscountThe 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:
objectTitle:
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:
objectTitle:
Total Contract MarginThe 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:
objectTitle:
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:
objectTitle:
Total Monthly CostThe 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:
objectTitle:
Total Discount Per MonthThe total of discounts off monthly recurring charges.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Total (List) Per Month
Type:
objectTitle:
Total (List) Per MonthThe 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:
objectTitle:
Total Monthly MarginThe 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:
objectTitle:
Total (Net) Per MonthThe 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:
objectTitle:
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:
objectTitle:
Total One-Time CostThe 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:
objectTitle:
Total DiscountThe 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:
objectTitle:
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:
objectTitle:
Total One-Time MarginThe 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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Win/Loss Status
Type:
objectTitle:
Show Source
Win/Loss Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Value
Type:
objectTitle:
ValueComposite attribute value
Nested Schema : state
Type:
objectTitle:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
-
actions:
object Actions
Title:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action. -
defaultRowState:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
focus:
object Focused Users
Title:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier. -
hasError:
boolean
Title:
Has ErrorBoolean value that specifies whether any error that occurred has been assigned to the collection itself. -
hasWarning:
boolean
Title:
Has WarningBoolean value that specifies whether any warning that was issued has been assigned to the collection itself. -
insertable:
boolean
Title:
InsertableBoolean value that specifies whether new rows can be inserted into the collection. -
messages:
array Messages
Title:
MessagesArray of messages that have been generated for a specific object. -
queryable:
boolean
Title:
QueryableBoolean value that specifies whether the rows in the collection can be queried. -
sortable:
boolean
Title:
SortableBoolean value that specifies whether the rows in the collection can be sorted.
Nested Schema : Actions
Type:
objectTitle:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Focused Users
Type:
objectTitle:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Comments
Type:
objectTitle:
Show Source
Comments-
_bs_id:
integer
Title:
_bs_id_bs_id -
_currency_pref:
object _currency_pref
Title:
_currency_pref -
_document_number:
integer
Title:
_document_number_document_number -
_row_number:
integer
Title:
_row_number_row_number -
_s_commentDate:
string
Title:
Comment DateThe date of comment. -
_s_commentor:
string
Title:
CommentorName of the person who created this comment. -
_s_customerComment:
string
Title:
Customer CommentThe comment text -
_s_isInternalComment:
boolean
Title:
Is Internal CommentDetermines if this comment should be visible to customer/buyer persona. -
_sequence_number:
integer
Title:
_sequence_number_sequence_number -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Nested Schema : _currency_pref
Type:
objectTitle:
Show Source
_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Nested Schema : Actions
Type:
objectTitle:
ActionsCaptures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type:
objectTitle:
AttributesCaptures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Focused Users
Type:
objectTitle:
Focused UsersDetails about users who are focused on this item. The object contains one property per focused user, where the property name is the user's unique identifier.
Nested Schema : Messages
Type:
arrayTitle:
MessagesArray of messages that have been generated for a specific object.
Show Source
-
Array of:
string
An error, warning, or informational message.
Nested Schema : Approval History
Type:
objectTitle:
Approval HistoryThis attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Show Source
-
actionPerformed:
string
Title:
actionPerformedString value that specifies actionPerformed. -
performDate:
string
Title:
performDateDate value that specifies performDate. -
performerComment:
string
Title:
performerCommentString value that specifies performerComment. -
performerCompany:
string
Title:
performerCompanyString value that specifies performerCompany. -
performerName:
string
Title:
performerNameString value that specifies performerName. -
reasonName:
string
Title:
reasonNameString value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarNameString value that specifies reasonVarName. -
revisionNumber:
integer
Title:
revisionNumberInteger value that specifies revisionNumber.
Nested Schema : Approval Reject Status
Type:
objectTitle:
Approval Reject StatusThis attribute lists all approval and reject status details for current logged in user.
Show Source
-
approverNames:
array approverNames
Title:
approverNamesString value that specifies approverNames. -
reasonName:
string
Title:
reasonNameString value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarNameString value that specifies reasonVarName.
Nested Schema : approverNames
Type:
arrayTitle:
approverNamesString value that specifies approverNames.
Show Source
-
Array of:
string
String value of an element's unique identifier.
Nested Schema : Approval Reject Icon
Type:
objectTitle:
Approval Reject IconThis attribute lists all approval and reject icon details for current logged in user.
Show Source
-
approvalId:
integer
Title:
approvalIdInteger value that specifies approvalId. -
approveActionId:
integer
Title:
approveActionIdInteger value that specifies approveActionId. -
approveActionLabel:
string
Title:
approveActionLabelString value that specifies approveActionLabel. -
approveIcon:
string
Title:
approveIconString value that specifies approveIcon. -
reasonName:
string
Title:
reasonNameString value that specifies reasonName. -
reasonVarName:
string
Title:
reasonVarNameString value that specifies reasonVarName. -
rejectActionId:
integer
Title:
rejectActionIdInteger value that specifies rejectActionId. -
rejectIcon:
string
Title:
rejectIconString value that specifies rejectIcon. -
rejectIconLabel:
string
Title:
rejectIconLabelString value that specifies approveActionLabel.
Nested Schema : items
Type:
Show Source
array-
Array of:
object Transaction Line
Title:
Transaction Line
Nested Schema : Transaction Line
Type:
objectTitle:
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 AttributeComposite 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 AttributeComposite attribute is used to display one or more fields belonging to a family of attributes. -
_config_attr_values:
string
Title:
Config Attribute ValuesStores 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 AttributeComposite attribute is used to display one or more fields belonging to a family of attributes. -
_config_extra_info:
string
Title:
Config Extra InfoConfiguration Extra Information. -
_configuration_id:
string
Title:
Configuration IDConfiguration id for integrations. -
_date_added:
string
Title:
_date_added -
_date_modified:
string
Title:
_date_modified -
_delta_price:
object Delta Price
Title:
Delta PriceDelta Price -
_document_number:
integer
Title:
_document_number -
_document_var_name:
string
Title:
_document_var_name -
_group_sequence_number:
string
Title:
Group Sequence NumberGroup sequence number for the subdocument. -
_id:
integer
Title:
_id -
_is_bom_price:
boolean
Title:
Is BOM PriceUsed to identify if the line item has BOM price. Applicable for a BOM item only -
_is_coverage:
boolean
Title:
Is Coverage ProductIndicates whether the product is of coverage type -
_is_line_item_mandatory:
boolean
Title:
Is Line Item MandatoryUsed to identify if the line item is mandatory. -
_is_part_pricing_rule_price:
boolean
Title:
Is Price from Pricing RuleUsed to identify if a line item has a part pricing rule set by a rule -
_is_recommended_price:
boolean
Title:
Is Price RecommendedUsed to identify if the line item has recommended price set by a rule. -
_last_modified_date:
string
Title:
Last Modified DateUsed to Store the last modified date of the sub-document. -
_line_bom_attributes:
string
Title:
Line Item BOM AttributesBOM attributes, stored as a JSON string. -
_line_bom_condition_index:
string
Title:
Line BOM Condition IndexThe condition index of the BOM item -
_line_bom_display_name:
string
Title:
Line BOM Display NameThe display name of the BOM item -
_line_bom_effective_date:
string
Title:
Line BOM Effective DateSystem 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 IDThe BOM item instance id. -
_line_bom_item_quantity:
integer
Title:
Line BOM Item QuantityThe BOM item line quantity. This is the unexploded line quantity, whereas _price_quantity stores the exploded quantity. -
_line_bom_level:
integer
Title:
Line BOM LevelThe BOM item depth (level) in the quote. -
_line_bom_model_path:
string
Title:
Line BOM Model PathThe model path of the BOM item; only applicable to the model line -
_line_bom_name:
string
Title:
Line BOM NameThe name of the BOM item -
_line_bom_parent_id:
string
Title:
Parent Line Item BOM IDThe parent BOM item instance id. -
_line_bom_part_number:
string
Title:
Line BOM Part NumberThe part number of the BOM item. Only applicable to the model line. -
_line_bom_sequence_index:
string
Title:
Line BOM Sequence IndexThe sequence index of the BOM item -
_line_bom_variable_name:
string
Title:
Line BOM Variable NameThe variable name of the BOM item -
_line_display_name:
string
Title:
Line Display NameDisplay name attribute for line items. -
_line_item_comment:
string
Title:
Line Item CommentsStores the comments for the line item. -
_line_item_spare_rule_var_name:
string
Title:
Line Item IdentifierIdentifier 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 TypeType attribute for line items. -
_model_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite AttributeComposite 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 PriceBase price of the model -
_model_bom:
string
Title:
Model BOMModel BOM Link -
_model_id:
string
Title:
Model IDId of the model -
_model_is_valid:
boolean
Title:
Is Model ValidCheck if model is configured or unconfigured -
_model_name:
string
Title:
Model NameName of the model -
_model_partner_entity_id:
string
Title:
Model Partner Entity IdPartner entity id for the model -
_model_partner_organization_id:
string
Title:
Model Partner Organization Idpartner organization id for the model -
_model_product_line_attributes:
object Commerce Composite Attribute
Title:
Commerce Composite AttributeComposite attribute is used to display one or more fields belonging to a family of attributes. -
_model_product_line_id:
string
Title:
Model Product Line IDId of the Product Line to which the model belongs -
_model_product_line_name:
string
Title:
Model Product Line NameProduct Line to which the model belongs -
_model_product_line_var_name:
string
Title:
Model Product Line Variable NameVariable name of the product line that the model belongs to. -
_model_sales_product_type:
string
Title:
Model Sales Product TypeProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_model_segment_id:
string
Title:
Model Segment IDId of the Segment to which the model belongs -
_model_segment_name:
string
Title:
Model Segment NameSegment to which the model belongs -
_model_segment_var_name:
string
Title:
Model Segment Variable NameSegment to which the model belongs -
_model_supplier_company_id:
string
Title:
Model Supplier Company IDModel supplier company id -
_model_supplier_company_name:
string
Title:
Model Supplier Company NameModel supplier company name -
_model_variable_name:
string
Title:
Model Variable NameVariable name of the model -
_original_document_number:
string
Title:
Original Document NumberUsed to identify the document number from which the line item is copied. -
_parent_doc_number:
string
Title:
Parent Document NumberUsed to identify the parent document number, if any, for this subdocument. -
_parent_line_item:
string
Title:
Parent Line ItemUsed to identify the name of the parent line item, if any, for this subdocument. -
_part_base_price:
object Part Base Price
Title:
Part Base PricePrice of the part -
_part_company_associations:
string
Title:
Company AssociationsCompany Associations -
_part_css_enabled:
string
Title:
Enable Customer Self-ServiceCustomer Self-service enabled flag -
_part_custom_field5:
number
Title:
Cost -
_part_default_periodicity:
string
Title:
Part Price PeriodDefault Price Periodicity -
_part_default_periods:
string
Title:
Number of Price PeriodsDefault number of price periods -
_part_default_price_type:
string
Title:
Part Price TypeDefault Price Type -
_part_default_uom:
string
Title:
Default UOM CodeDefault unit of measure -
_part_desc:
string
Title:
Part DescriptionDescription of the part -
_part_direct_buy:
string
Title:
Direct BuyDirect Buy -
_part_display_number:
string
Title:
Part Display NumberPart Display Number -
_part_drawing_position:
string
Title:
Drawing PositionDrawing Position -
_part_extended_desc_1:
string
Title:
Part Extended Description 1Extended description of the part -
_part_extended_desc_2:
string
Title:
Part Extended Description 2Extended description of the part -
_part_external_key1:
string
Title:
External Key 1External system's key -
_part_external_key2:
string
Title:
External Key 2External system's key -
_part_id:
string
Title:
Part IDId of the part -
_part_lead_time:
string
Title:
Part Lead TimeLead time -
_part_number:
string
Title:
Part NumberPart Number -
_part_sale_enabled:
string
Title:
Eligible to SellEligible to sell or order -
_part_sales_product_type:
string
Title:
Sales Product TypeProductTypeCode Valid values comes from a lookup. E.g Goods, Included Warranty etc. -
_part_serv_req_enabled:
string
Title:
Eligible for ServiceEligible for service -
_part_service_duration_type_code:
string
Title:
Service Duration TypeService Duration Type -
_part_supplier_company_id:
string
Title:
Part Supplier Company IDId of the part supplier company -
_part_supplier_company_name:
string
Title:
Part Supplier Company NameName of the part supplier company -
_part_units:
string
Title:
Part UnitsUnits of the part -
_partner_entity_id:
string
Title:
Partner Entity IdPartner Entity Id -
_partner_organization_id:
string
Title:
Partner Organization IdPartner Organization Id -
_pp_id:
integer
Title:
_pp_id -
_pp_name:
string
Title:
_pp_name -
_price_applied_agreement_integrationId:
string
Title:
Applied Agreement Integration IDApplied Agreement Integration Id -
_price_applied_agreement_name:
string
Title:
Applied Agreement NameApplied Agreement Name -
_price_applied_agreement_number:
string
Title:
Applied Agreement NumberApplied Agreement Number -
_price_applied_ratePlan:
string
Title:
Applied Rate PlanApplied Rate Plan -
_price_applied_ratePlan_integrationId:
string
Title:
Applied Rate Plan Integration IDApplied Rate Plan Integration Id -
_price_applied_ratePlan_number:
string
Title:
Applied Rate Plan NumberApplied Rate Plan Number -
_price_book_var_name:
string
Title:
Price Book Variable NameVariable Name of the Price Book used to get the price for this line item -
_price_calculation_info:
string
Title:
Calculation InformationJSON array of aggregated calculation information returned from advanced pricing profiles -
_price_component_prices:
object Commerce Composite Attribute
Title:
Commerce Composite AttributeComposite attribute is used to display one or more fields belonging to a family of attributes. -
_price_configurable_price:
object Configurable Price
Title:
Configurable PriceOriginal price as per catalog (inclusive of discount and premium) -
_price_item_price_each:
object Item Price
Title:
Item PriceThe 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 PriceWill usually be the same value as the Item Price, unless a recommended item price applies. -
_price_period:
string
Title:
Pricing Engine Price PeriodPeriod for which the price will be applicable. -
_price_quantity:
integer
Title:
QuantityQuantity -
_price_type:
string
Title:
Pricing Engine Price TypeType of price (For example: One-time, Periodic - monthly, quarterly etc) -
_price_unit_price_each:
object Unit Price
Title:
Unit PriceWill 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 PriceCurrenly the customer level pricing. (Not applicable for Models) -
_prior_price:
object Prior Price
Title:
Prior PricePrior Price -
_reconfiguration_date:
string
Title:
Reconfiguration DateUsed 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 IDThe ID of the Revenue Line Item in the associated opportunity. -
_rollup_delta_price:
object Rollup Delta Price
Title:
Rollup Delta PriceRollup Delta Price -
_s_coverageLineNumber:
string
Title:
Coverage Line NumberSource line number of the coverage line for OM Integration. -
_s_coverageOrderNumber:
string
Title:
Coverage Order NumberSource order number of the coverage line for OM Integration. -
_s_freezeNegotiationFlag_l:
boolean
Title:
Freeze Negotiation FlagFlag indicating whether price negotiation is permitted. -
_s_html_line_scatterplot_l:
string
Title:
html_line_scatterplotHold line scatter plot graph. -
_s_html_line_timeseries_l:
string
Title:
html_line_timeseries_lHold line time series graph. -
_s_lastPricePaid_l:
object Last Price Paid
Title:
Last Price PaidThe most recent price at which the part/model was quoted. -
_s_lastPricePaidCustomerId_l:
object Last Price Paid (CustomerId)
Title:
Last Price Paid (CustomerId)The most recent price at which the part/model was quoted to the customer. -
_s_lineDiscountGuidanceCeiling_l:
number
Title:
Line Discount Guidance CeilingUpper bound of the line discount guidance. -
_s_lineDiscountGuidanceFloor_l:
number
Title:
Line Discount Guidance FloorLower bound of the line discount guidance. -
_s_lineDiscountGuidanceMax_l:
number
Title:
Line Discount Guidance MaxMax of the line discount guidance. -
_s_lineDiscountGuidanceMeterGauge_l:
string
Title:
Line Discount Guidance Meter GaugeHold line discount guidance graph. -
_s_partID_l:
string
Title:
Part IDPart number from the Items table. -
_s_priceScoreListBased_l:
integer
Title:
Price Score List BasedList Based Method price score calculation for line. -
_s_priceScoreMarginBased_l:
integer
Title:
Price Score Margin BasedMargin Based Method price score calculation for a line. -
_s_priceScoreSimpleMarginListPrice_l:
integer
Title:
Price Score Simple Margin Based (List Price Basis)Price score calculation using Simple Margin Based method and List Price as Basis attribute. -
_s_priceScoreSimpleMarginNetPrice_l:
integer
Title:
Price Score Simple Margin Based (Net Price Basis)Price score calculation using Simple Margin Based method and Net Price as Basis attribute. -
_s_priceScoreSimpleMarginUnitCost_l:
integer
Title:
Price Score Simple Margin Based (Unit Cost Basis)Price score calculation using Simple Margin Based method and Unit Cost as Basis attribute. -
_s_priceScoreWeighting_l:
number
Title:
Price Score WeightingWeighting attribute for price score calculation at the transaction level. -
_sequence_number:
integer
Title:
Sequence NumberSequence number for the subdocument. -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_step_var_name:
string
Title:
_step_var_name -
_transaction_currency_pref:
string
Title:
_transaction_currency_pref -
_transactionLine_id:
string
Title:
Transaction Line IDUnique identifier for this subdocument. -
aBO_Delta_Action_Code_l:
object Line Delta Action Code
Title:
Line Delta Action Code -
annualCost_l:
object Annual Cost
Title:
Annual CostThe extended cost for recurring pricing on this transaction line. -
annualDiscount_l:
object Annual Discount
Title:
Annual DiscountThe 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 MarginThe 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 IdDocument number to be associated with the subscription line. -
associatedOrderId_l:
string
Title:
Associated Order IdSource 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 CostThe total of all contract extended costs for this line, including one-time and recurring costs. -
contractDiscount_l:
object Contract Discount
Title:
Contract DiscountThe total discount of this line including all one-time and recurring charges. -
contractedPeriods_l:
integer
Title:
Contracted PeriodsNumber 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 DateDate 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 MarginThe total of all contract extended margins for this line, including one-time and recurring values. -
contractStartDate_l:
string
Title:
Contract Start DateDate 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 AmountThe total cost of this line. -
createdBy_l:
string
Title:
Created ByThe person that created the transaction line. -
createdDate_l:
string
Title:
Created DateThe date when the transaction line was created. -
customDiscountAmount_l:
object Custom Discount Amount
Title:
Custom Discount AmountThe 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:
DiscountUsed 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. -
docNumber_l:
string
Title:
Document NumberDocument number of the line. -
fulfillmentLineId_l:
string
Title:
Fulfillment Line IdValue that uniquely identifies the fulfillment line. -
fulfillmentOrganizationCode_l:
string
Title:
Fulfillment Organization CodeAbbreviation that identifies the organization that ships the shipment. -
fulfillmentStatus_l:
object Fulfillment Status
Title:
Fulfillment Status -
includedInBasePrice:
boolean
Title:
Included In Base PriceUsed to identify if the line item is included in the base price. Applicable for a BOM item only. -
itemInstanceId_l:
string
Title:
Instance IDThe 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 NameThe 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 ByThe person that last updated this transaction line. -
lastUpdatedDate_l:
string
Title:
Last UpdatedThe date and time the transaction line was last updated. -
lineNumber_l:
integer
Title:
Line NumberLine 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 AmountThe 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 AttributesA 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_charges:
object TransactionLineORCL_charges-collection
-
oRCL_ERP_OrderNumber_l:
string
Title:
Order NumberThe order number assigned by the external Order Management and ERP system. -
oRCL_SFA_InventoryItemID_l:
string
Title:
Inventory Item IDThe inventory item id of the sales product in SFA. -
oRCL_SFA_InventoryOrgID_l:
string
Title:
Partner Orgnanization IDThe 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 DateThe date and time the order was placed for fulfillment. -
ownerResourceId_l:
string
Title:
Owner Resource IDThe owner of the associated Opportunity Revenue Line. -
parentAssetKey_l:
string
Title:
Parent Asset KeyThe identifier for the corresponding parent asset in an external asset repository. Used only for asset-related lines. -
parentDocNumber_l:
string
Title:
Parent Doc NumberDocument 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 ScoreThe 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 PolicyFlag 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 DateRenewal date of a subscription service. -
requestDate_l:
string
Title:
Request DateThe 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 DateThe requested ship date for the order line. -
resumeDate_l:
string
Title:
Resume DateResuming date of a subscription service -
rollupFlag_l:
boolean
Title:
Rollup FlagSpecifies 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 IdThe unique identifier for the subscription. Used only for subscription billing-related transactions. -
subscriptionLineId_l:
string
Title:
Subscription Line IdThe unique identifier for the subscription line. Used only for subscription billing-related transactions. -
suspendDate_l:
string
Title:
Suspend DateSuspension date of a subscription service -
transactionID_l:
string
Title:
Transaction Internal IDThe parent transaction's internal ID. -
unitCost_l:
object Unit Cost
Title:
Unit CostThe unit cost of the item. -
unitMargin_l:
object Margin
Title:
MarginThe 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:
objectTitle:
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:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : TransactionLine_chargeSet-collection
Type:
Show Source
object-
_state:
object state
Title:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Delta Price
Type:
objectTitle:
Delta PriceDelta Price
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Model Base Price
Type:
objectTitle:
Model Base PriceBase price of the model
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Part Base Price
Type:
objectTitle:
Part Base PricePrice of the part
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Configurable Price
Type:
objectTitle:
Configurable PriceOriginal price as per catalog (inclusive of discount and premium)
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Item Price
Type:
objectTitle:
Item PriceThe 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:
objectTitle:
List PriceWill 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:
objectTitle:
Unit PriceWill 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:
objectTitle:
Pricing Rule PriceCurrenly the customer level pricing. (Not applicable for Models)
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Prior Price
Type:
objectTitle:
Prior PricePrior Price
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Revenue Category
Type:
objectTitle:
Show Source
Revenue Category-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Rollup Delta Price
Type:
objectTitle:
Rollup Delta PriceRollup Delta Price
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Last Price Paid
Type:
objectTitle:
Last Price PaidThe most recent price at which the part/model was quoted.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Last Price Paid (CustomerId)
Type:
objectTitle:
Last Price Paid (CustomerId)The most recent price at which the part/model was quoted to the customer.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Line Delta Action Code
Type:
objectTitle:
Show Source
Line Delta Action Code-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Annual Cost
Type:
objectTitle:
Annual CostThe extended cost for recurring pricing on this transaction line.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Annual Discount
Type:
objectTitle:
Annual DiscountThe 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:
objectTitle:
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:
objectTitle:
Annual MarginThe 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:
objectTitle:
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:
objectTitle:
Show Source
Cancel Reason-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Change Code
Type:
objectTitle:
Show Source
Change Code-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Change Reason
Type:
objectTitle:
Show Source
Change Reason-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Contract Cost
Type:
objectTitle:
Contract CostThe 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:
objectTitle:
Contract DiscountThe 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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
Contract MarginThe 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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
Cost AmountThe total cost of this line.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Custom Discount Amount
Type:
objectTitle:
Custom Discount AmountThe 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:
objectTitle:
Show Source
Discount Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Amount (Discount)
Type:
objectTitle:
Amount (Discount)The discount amount for this line.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Fulfillment Status
Type:
objectTitle:
Show Source
Fulfillment Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Line Type
Type:
objectTitle:
Show Source
Line Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Amount (List)
Type:
objectTitle:
Amount (List)The extended list amount for this line.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Price (List)
Type:
objectTitle:
Price (List)The list price of the item.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : List Price (Rollup)
Type:
objectTitle:
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:
objectTitle:
Margin AmountThe margin for all quoted units of this transaction line.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : MRR (Rollup)
Type:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
Show Source
Action Code-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : TransactionLineORCL_charges-collection
Type:
Show Source
object-
_state:
object state
Title:
stateCaptures the current state of the resource collection. Of available properties, only those that are applicable and whose values are known in the current context are included. -
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Payment Terms
Type:
objectTitle:
Show Source
Payment Terms-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Period
Type:
objectTitle:
Show Source
Period-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency
Type:
objectTitle:
Show Source
Price Recurrence Frequency-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Recurrence Frequency (Rollup)
Type:
objectTitle:
Show Source
Price Recurrence Frequency (Rollup)-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Type (Rollup)
Type:
objectTitle:
Show Source
Price Type (Rollup)-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Recurring Revenue (Rollup)
Type:
objectTitle:
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:
objectTitle:
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:
objectTitle:
Show Source
Unit of Measure-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Root Line
Type:
objectTitle:
Show Source
Root Line-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Sales Channel
Type:
objectTitle:
Show Source
Sales Channel-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Status
Type:
objectTitle:
Show Source
Status-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Unit Cost
Type:
objectTitle:
Unit CostThe unit cost of the item.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Margin
Type:
objectTitle:
MarginThe 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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
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:
objectTitle:
Show Source
Available Rate Plan Set-
_availableRatePlanSet_rate_plan_integration_id:
string
Title:
Available Rate Plan Integration IdRate Plan Integration ID -
_availableRatePlanSet_rate_plan_name:
string
Title:
Available Rate Plan NameRate plan name -
_availableRatePlanSet_rate_plan_number:
string
Title:
Available Rate Plan NumberRate 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:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_transaction_currency_pref:
object _transaction_currency_pref
Title:
_transaction_currency_pref
Nested Schema : _transaction_currency_pref
Type:
objectTitle:
Show Source
_transaction_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Nested Schema : Charge Set
Type:
objectTitle:
Show Source
Charge Set-
_bs_id:
integer
Title:
_bs_id_bs_id -
_chargeSet_calculationInfo:
string
Title:
Calculation InformationA JSON array of the Price Models used in calculating this charge's price. -
_chargeSet_chargeDefinition:
string
Title:
Charge DefinitionThe display label of the charge definition. -
_chargeSet_chargeDefinitionCode:
string
Title:
Charge Definition CodeThe code of the charge definition. -
_chargeSet_chargeDefIntegrationId:
string
Title:
Charge Definition Integration IDThe charge definition code in the integrated order management system. -
_chargeSet_chargeType:
object Charge Type
Title:
Charge Type -
_chargeSet_discountAmount:
object Discount Amount
Title:
Discount AmountThe extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity. -
_chargeSet_discountType:
object Discount Type
Title:
Discount Type -
_chargeSet_discountValue:
number
Title:
Discount ValueThe numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge. -
_chargeSet_dynamicPricingType:
string
Title:
Dynamic Pricing TypeThe type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced. -
_chargeSet_netAmount:
object Net Amount
Title:
Net AmountThe extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity. -
_chargeSet_netPrice:
object Net Price
Title:
Net PriceThe unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced. -
_chargeSet_pricePeriod:
object Price Period
Title:
Price Period -
_chargeSet_priceType:
object Price Type
Title:
Price Type -
_chargeSet_rateCardInHTML:
string
Title:
Rate Card In HTMLThe HTML-formatted rate card data -
_chargeSet_rateCardName:
string
Title:
Rate CardDisplay label for the Rate Card applied in calculating this charge's price. -
_chargeSet_rateCardStructure:
string
Title:
Rate Card StructureThe rate card used to calculate this charge's price. -
_chargeSet_rateCardVariableName:
string
Title:
Rate Card Variable NameVariable Name for the Rate Card applied in calculating this charge's price. -
_chargeSet_unitPrice:
object Unit Price
Title:
Unit PriceThe unit price to be paid by the customer for this charge. -
_chargeSet_usageUOM:
object Usage UOM
Title:
Usage UOM -
_document_number:
integer
Title:
_document_number_document_number -
_row_number:
integer
Title:
_row_number_row_number -
_sequence_number:
integer
Title:
_sequence_number_sequence_number -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_transaction_currency_pref:
object _transaction_currency_pref
Title:
_transaction_currency_pref
Nested Schema : Charge Type
Type:
objectTitle:
Show Source
Charge Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Discount Amount
Type:
objectTitle:
Discount AmountThe extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Discount Type
Type:
objectTitle:
Show Source
Discount Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Net Amount
Type:
objectTitle:
Net AmountThe extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Net Price
Type:
objectTitle:
Net PriceThe unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Price Period
Type:
objectTitle:
Show Source
Price Period-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : Unit Price
Type:
objectTitle:
Unit PriceThe unit price to be paid by the customer for this charge.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : Usage UOM
Type:
objectTitle:
Show Source
Usage UOM-
displayValue:
string
Title:
displayValue -
value:
string
Title:
value
Nested Schema : _transaction_currency_pref
Type:
objectTitle:
Show Source
_transaction_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Nested Schema : Prices
Type:
objectTitle:
Show Source
Prices-
_bs_id:
integer
Title:
_bs_id_bs_id -
_document_number:
integer
Title:
_document_number_document_number -
_row_number:
integer
Title:
_row_number_row_number -
_s_oRCL_chargeDefIntegrationId:
string
Title:
Charge Definition Integration ID -
_s_oRCL_chargeType:
string
Title:
Charge Type -
_s_oRCL_customDiscountType:
string
Title:
Custom Discount Type -
_s_oRCL_pricePeriod:
string
Title:
Price Period -
_s_oRCL_priceType:
string
Title:
Price Type -
_s_oRCL_priceUOM:
string
Title:
Price Unit of Measure -
_sequence_number:
integer
Title:
_sequence_number_sequence_number -
_state:
object state
Title:
stateCaptures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included. -
_transaction_currency_pref:
object _transaction_currency_pref
Title:
_transaction_currency_pref -
oRCL_applyTo:
string
Title:
Apply To -
oRCL_chargeName:
string
Title:
Charge Name -
oRCL_chargeSequenceNumber:
integer
Title:
Sequence Number -
oRCL_contractDiscountAmount:
number
Title:
Contract Discount Amount -
oRCL_contractListValue:
number
Title:
Contract List Value -
oRCL_contractNetValue:
number
Title:
Contract Net Value -
oRCL_customDiscountAmount:
number
Title:
Custom Discount Amount -
oRCL_discountAmount:
number
Title:
Discount Amount -
oRCL_listAmount:
number
Title:
List Amount -
oRCL_listPrice:
number
Title:
List Price -
oRCL_netAmount:
number
Title:
Net Amount -
oRCL_netPrice:
number
Title:
Net Price -
oRCL_primaryCharge:
boolean
Title:
Primary Charge
Nested Schema : _transaction_currency_pref
Type:
objectTitle:
Show Source
_transaction_currency_pref-
currencyCode:
string
Title:
Currency CodeUnique currency code for the currency. -
id:
integer
Title:
IdPrimary Key of the currency resource.
Examples
The following example shows how to access a particular Transaction in a Commerce Process by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365138
Response Body Sample
The following example shows the contents of the response body in JSON format, including the Transaction:
{
"_last_document_number" : "1",
"paymentTerms_t" : "Net 30",
"bs_id" : "36311839",
"_price_book_var_name" : "",
"totalOneTimeNetAmount_t" : "60045.28",
"currentStepForTesting_tempDisplay_t" : "start_step",
"totalMonthlyDiscount_t" : "0",
"_customer_t_address" : "1234 Test Rd",
"_step_var_name" : "start_step",
"_curr_reason_variable_name" : "",
"transactionName_t" : "TestCo1 #1",
"parent_transaction_id_versionTransaction_t" : "36311839",
"_supplier_company_name" : "cpq",
"status_t" : "CREATED",
"approve_reject_icon_submit_t" : "",
"_document_link" : "",
"createdDate_t" : "2015-02-26 00:00:00",
"_customer_t_state" : "IL",
"_curr_reason_desc" : "",
"_document_number" : "1",
"requireApprovalIfChecked_temporary_t" : "false",
"opportunityName_t" : "",
"totalMonthlyNetAmount_t" : "4899.89",
"_date_added" : "2015-11-15 19:49:25.0",
"_process_var_name" : "oraclecpqo",
"userKey_t" : "CPQ-3v12",
"_date_modified" : "2015-11-15 21:05:41.0",
"_customer_t_address_2" : "",
"taxExempt_t" : "false",
"totalAnnualValue_t" : "118843.96",
"salesChannel_t" : "",
"approval_revision_submit_t" : "1",
"_id" : "36365138",
"_invoiceTo_t_last_name" : "Co",
"_invoiceTo_t_phone" : "555-555-5555",
"statusPartial_t" : "false",
"_invoiceTo_t_company_name" : "TestCo1",
"_customer_t_city" : "Chicago",
"_customer_t_email" : "testco1@testco1.com",
"createdBy_t" : "Anna Howell",
"_customer_t_last_name" : "Co",
"priceExpirationDate_t" : "",
"lastPricedDate_t" : "2015-02-26 10:15:00",
"_curr_reason_name" : "",
"_invoiceTo_t_state" : "IL",
"_customer_t_first_name" : "Test",
"statusDate_t" : "",
"totalContractValue_t" : "236133.32",
"_invoiceTo_t_address_2" : "",
"purchaseOrderNumber_t" : "",
"version_t" : "1",
"_invoiceTo_t_email" : "testco1@testco1.com",
"approval_status_submit_t" : "",
"_customer_t_company_name_2" : "",
"opportunityID_t" : "",
"totalOneTimeDiscount_t" : "310",
"currency_t" : "USD",
"_document_var_name" : "transaction",
"hasRecurringPricing_t" : "true",
"_customer_t_zip" : "60641",
"_customer_t_company_name" : "TestCo1",
"_invoiceTo_t_zip" : "60641",
"_invoiceTo_t_company_name_2" : "",
"totalMonthlyListAmount_t" : "4899.89",
"taxExemptReason_t" : "",
"_buyer_company_name" : "cpq",
"_next_approver" : "",
"totalOneTimeListAmount_t" : "60355.28",
"_submitted_by_submit_t" : "",
"_invoiceTo_t_address" : "1234 Test Rd",
"approval_history_submit_t" : "",
"_customer_t_fax" : "555-555-5555",
"_customer_t_phone" : "555-555-5555",
"_transaction_total" : "236133.32",
"_invoiceTo_t_first_name" : "Test",
"lastUpdatedBy_t" : "Super User",
"priceWithinPolicy_t" : "true",
"owner_t" : "Anna Howell",
"lastUpdatedDate_t" : "2015-02-26 10:23:00",
"_approve_reject_comment" : "",
"transactionID_t" : "CPQ-3",
"_currency_pref" : "USD",
"_submit_comment" : "",
"_invoiceTo_t_fax" : "555-555-5555",
"_curr_approver" : "",
"version_number_versionTransaction_t" : "2",
"_customer_t_country" : "United States",
"_invoiceTo_t_city" : "Chicago",
"_invoiceTo_t_country" : "United States",
"links" : [ {
"rel" : "self",
"href" : "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365138"
}, {
"name" : "transactionLine",
"rel" : "child",
"href" : "https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/36365138/transactionLine",
"kind" : ""
} ]
}