Standard Process Transaction Attributes
The following table lists Transaction attributes provided in the Standard Process.
Name | Variable Name | Type | Description |
---|---|---|---|
Account Address Element Attribute 1 |
accountAddressElementAttribute1_t |
Text |
Account AddressElementAttribute1 |
Account Address Element Attribute 2 |
accountAddressElementAttribute2_t |
Text |
Account AddressElementAttribute2 |
Account Address Element Attribute 3 |
accountAddressElementAttribute3_t |
Text |
Account AddressElementAttribute3 |
Account Address Element Attribute 4 |
accountAddressElementAttribute4_t |
Text |
Account AddressElementAttribute4 |
Account Address Element Attribute 5 |
accountAddressElementAttribute5_t |
Text |
Account AddressElementAttribute5 |
Account Address Line 1 |
accountAddressLine1_t |
Text |
First line of the account address |
Account Address Line 2 |
accountAddressLine2_t |
Text |
Second line of the account address |
Account Address Line 3 |
accountAddressLine3_t |
Text |
Third line of the account address |
Account Address Line 4 |
accountAddressLine4_t |
Text |
Fourth line of the account address |
Account Address Type |
addressType_t |
Menu |
Address type of the account address |
Account City |
accountCity_t |
Text |
City of the account |
Account Contact Number |
_s_accountContactNumber_t |
Text |
Contact number of the account. |
Account Country |
accountCountry_t |
Text |
Country of the account |
Account Email Address |
accountEmailAddress_t |
Text |
Email address of the account |
Account First Name |
accountFirstName_t |
Text |
First Name of the Account Contact |
Account Integration Response |
_s_accountIntegrationResponse_t |
Text Area |
Holds the response of TCA account integration. |
Account Last Name |
accountLastName_t |
Text |
Last Name of the Account Contact |
Account Middle Name |
accountMiddleName_t |
Text |
Middle Name of the Account Contact |
Account Name |
accountName_t |
Text |
The attribute which captures the name of the Account |
Account Name Suffix |
accountNameSuffix_t |
Text |
Name suffix of the Account contact |
Account Party Number |
_s_accountPartyNumber_t |
Text |
Identifier for the type of the account under the party. |
Account Party Id |
_s_accountPartyId_t |
Text |
The CDM integration provides the value for this field based on the Customer Company Name |
Account Postal Code |
accountPostalCode_t |
Integer |
Postal Code of the account |
Account Province |
accountProvince_t |
Text |
Province of the account |
Account State |
accountState_t |
Text |
State of the account |
Account Type |
accountType_t |
Menu |
Type of the customer account (Billing,Sales, etc.) |
Account Unique Name |
accountUniqueName_t |
Text |
Unique identifier for the Account contact |
Annual Contract Discount |
TotalAnnualDiscount_t |
Currency |
The total value each year of the discounts on recurring charges for the transaction. |
Annual Contract Value (List) |
annualContractListValue_t |
Currency |
The total of contract extended values at list price within the first year, including only recurring pricing. |
Annual Contract Value (Net) |
totalAnnualValue_t |
Currency |
The total value of recurring charges each year. |
Annual Cost |
totalAnnualCostAmount_t |
Currency |
The total of recurring extended costs each year for the transaction. |
Annual Margin |
totalAnnualMarginAmount_t |
Currency |
The total of recurring extended margins each year for the transaction. |
Assigned To |
_s_assignedTo_t |
Menu |
The business entity this transaction is assigned to for review. |
Bill to Customer Account Id |
_s_billToCustomerAccountID_t |
Text |
TCA account integration provides value from BillingAccountId to this field based on Customer Id and Business Unit ID |
Bill To Customer Account Name |
_s_billToCustomerAccountName_t |
Text |
TCA account integration provides value from BillingAccountName to this field based on Customer Id and Business Unit ID |
Bill To Site Use Id |
billToSiteUseId_t |
Text |
CDM integration will provide value to this field based on Customer company name |
Billing Frequency |
oRCL_billingFrequency_t |
Menu |
Determines the billing frequency for a subscription. |
Business Unit ID |
businessUnitId_t |
Text |
Customer business unit identifier. |
Business Unit Name |
businessUnitName_t |
Text |
Customer business unit name. |
Cancel Explanation |
cancelExplanation_t |
Text Area |
A detailed, free-form explanation of why the customer cancelled the sales order. This supplements the Cancel Reason selected by the sales user. |
Cancel Reason |
cancelReason_t |
Menu |
The reason expressed by the customer for canceling this order. The reason is selected by the sales user from a list of standard values for the site. |
Contact Address Element Attribute 1 |
contactAddressElementAttribute1_t |
Text |
Contact AddressElementAttribute1 |
Contact Address Element Attribute 2 |
contactAddressElementAttribute2_t |
Text |
Contact AddressElementAttribute2 |
Contact Address Element Attribute 3 |
contactAddressElementAttribute3_t |
Text |
Contact AddressElementAttribute3 |
Contact Address Element Attribute 4 |
contactAddressElementAttribute4_t |
Text |
Contact AddressElementAttribute4 |
Contact Address Element Attribute 5 |
contactAddressElementAttribute5_t |
Text |
Contact AddressElementAttribute5 |
Contact Address Line 1 |
contactAddressLine1_t |
Text |
First line of the contact address |
Contact Address Line 2 |
contactAddressLine2_t |
Text |
Second line of the contact address |
Contact Address Line 3 |
contactAddressLine3_t |
Text |
Third line of the contact address |
Contact Address Line 4 |
contactAddressLine4_t |
Text |
Fourth line of the contact address |
Contact City |
contactCity_t |
Text |
City of the contact |
Contact Country |
contactCountry_t |
Text |
Country of the contact |
Contact Email Address |
contactEmailAddress_t |
Text |
Email address of the contact |
Contact First Name |
contactFirstName_t |
Text |
First Name of the Contact |
Contact Last Name |
contactLastName_t |
Text |
Last Name of the Contact |
Contact Middle Name |
contactMiddleName_t |
Text |
Middle Name of the Contact |
Contact Name |
contactName_t |
Text |
The attribute which captures the Contact Name of the Account |
Contact Name Suffix |
contactNameSuffix_t |
Text |
Name suffix of the contact |
Contact Number |
_s_contactNumber_t |
Text |
Contact number of the contact. |
Contact Party Number |
_s_contactPartyNumber_t |
Text |
Identifier for the type of the contact under the party. |
Contact Postal Code |
contactPostalCode_t |
Text |
Postal Code of the contact |
Contact Province |
contactProvince_t |
Text |
Province of the contact |
Contact State |
contactState_t |
Text |
State of the contact |
Contact Type |
contactType_t |
Menu |
Type of the customer contact (Biiling,Sales, etc.) |
Contact Unique Name |
contactUniqueName_t |
Text |
Unique identifier for the Account contact |
Contract End Date |
contractEndDate_t |
Date |
Date that the customer stops receiving all of the products and services on the quote. Used when all services are co-terminated at the quote level. |
Contract ID |
_s_contractID_t |
Text |
The identifier of the CLM contract |
Contract Name |
contractName_t |
Text |
The attribute which captures the name of the CLM contract |
Contract Start Date |
contractStartDate_t |
Date |
Date that the customer starts to receive all of the products and services on the quote. Used when all services are co-terminated at the quote level. |
Contract Type ID |
_s_contractTypeID_t |
Text |
The identifier for the CLM contract Type. |
Contract Type Name |
contractTypeName_t |
Text |
The attribute which captures the contract type name of the CLM contract |
Contracted Periods |
contractedPeriods_t |
Integer |
Number of periods the customer has contracted to receive the transaction. |
Cover Letter |
coverLetter_t |
Rich Text |
The cover letter to be attached to the proposal document for this transaction. |
Create Order Rest Response |
createOrderRestResponse |
Text Area |
This attribute holds the rest response of create order |
Created By |
createdBy_t |
Text |
The person that created the transaction. |
Created Date |
createdDate_t |
Date |
The date when the transaction was created. |
Currency |
currency_t |
Menu |
The currency used to price and invoice this transaction. |
Current Step |
currentStepForTesting_tempDisplay_t |
Text |
This attribute is exposed only to the Administrator to assist in debugging modifications to the Commerce Process Steps and Transition Rules. |
Customer Id |
_customer_id |
Customer Id |
This is the special Customer ID (with attribute type = Customer ID) used in CPQ-platform-supplied CRM integrations. This attribute is associated with the automatically-created Autofill, Browse, Select Alternate Address, and View Actions. |
Customer Party Site ID |
_s_customerPartySiteID_t |
Text |
The ID for the Party Site or Address of the CRM Customer. |
Customer Status |
_s_customerStatus_t |
Menu |
The status of transaction for customer/buyer persona. |
Customer Visibility Identifier |
_s_customerVisibilityIdentifier_t |
Menu |
The identifier to determine fields that should be visible for customer/buyer persona. |
Default Request Date |
defaultRequestDate_t |
Date |
The date on which the user requests that fulfillment occur for this transaction. |
Discount Guidance Ceiling |
_s_discountGuidanceCeiling_t |
Float |
Upper bound of the discount guidance. |
Discount Guidance Floor |
_s_discountGuidanceFloor_t |
Float |
Lower bound of the discount guidance. |
Discount Guidance Max |
_s_discountGuidanceMax_t |
Float |
Max of the discount guidance. |
Discount Guidance Meter Gauge |
_s_discountGuidanceMeterGauge_t |
Read-only text or HTML |
Hold discount guidance graph. |
File Attachment |
fileAttachment_t |
File Attachment |
The file attachment containing the Proposal Document. |
Freeze Price Flag |
freezePriceFlag_t |
Boolean |
Determines whether the external system should use CPQ Pricing or not. If set to true, the external system will use CPQ Pricing. |
Fulfillment Status |
fulfillmentStatus_t |
Menu |
This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order. |
Has Recurring Pricing |
hasRecurringPricing_t |
Boolean |
Indicates whether this transaction uses recurring pricing. This is used to hide the recurrence period column in the line item grid. |
Host Company Full Name |
_s_hostCompanyFullName_t |
Text |
Full company name of current user's company. |
html_main_price_optimization |
_s_html_main_price_optimization_t |
Read-only text or HTML |
Hold 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. |
html_main_scatterplot |
_s_html_main_scatterplot_t |
Read-only text or HTML |
Hold header lever scatter plot graph. |
html_main_timeseries |
_s_html_main_timeseries_t |
Read-only text or HTML |
Hold Time Series graph. |
Invoice To Party ID |
invoiceToPartyID_t |
Text |
The Party ID for the Invoice To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer and Sold To Parties. |
Invoice To Party Site ID |
_s_invoiceToPartySiteID_t |
Text |
The ID for the Party Site or Address of the Invoice To party. |
Is Published |
_s_isPublished_t |
Boolean |
Indicates whether this quote was published to customer. This flag is set to true when the quote is published for the first time. |
Last Opportunity Sync |
oRCL_SFA_SyncTime_t |
Text |
The date and time on which the transaction was last synced to SFA. |
Last Priced |
lastPricedDate_t |
Date |
The date and time that this transaction was last re-priced. |
Last Updated |
lastUpdatedDate_t |
Date |
The date and time the transaction was last updated. |
Last Updated By |
lastUpdatedBy_t |
Text |
The person that last updated this transaction. |
Opportunity ID |
opportunityID_t |
Text |
The identifier of the parent opportunity. |
Opportunity Name |
opportunityName_t |
Text |
The name of the parent opportunity. |
Opportunity Number |
opportunityNumber_t |
Text |
The user or public identifier for the opportunity associated to this transaction. |
Opportunity Win/Loss Status |
oRCL_SFA_Status_t |
Text |
The current status of this transaction as it relates to SFA. This will differ from the other statuses of the transaction. The mapping of SFA status values to the statuses used in CPQ Cloud is administered in the Status data table. |
Optimal Primary Driver (Discount%) |
_s_optimalPrimaryDriver_t |
Float |
Optimal Discount% returned from Price Optimization analytic 'Optimized Discount%'. |
Optimal Target Value |
_s_optimalTargetValue_t |
Float |
Optimal Target Value returned from the Price Optimization based analytic 'Optimized Discount%'. |
Optimal Win Probability |
_s_optimalWinProbability_t |
Float |
Optimal Win Probability value returned from price optimization analytic 'Optimized Discount%'. |
Order Date |
orderDate_t |
Date |
The date and time the order was placed for fulfillment. |
Order ID |
oRCL_ERP_OrderID_t |
Text |
The Order ID assigned by the external ERP system to this transaction. |
Order Key |
orderKey_t |
Text |
Value that uniquely identifies the sales order. |
Order Number |
oRCL_ERP_OrderNumber_t |
Text |
The order number assigned by the external Order Management and ERP system. |
Ordered By |
orderPlacedBy_t |
Text |
Records the Current User when the Create Order Action is triggered |
Owner |
owner_t |
Text |
The person that owns this transaction. |
Owner Resource Party ID |
oRCL_SFA_OwnerResourcePartyID_t |
Text |
The SFA Party ID for the person owning this transaction. |
Partial Ship Allowed |
oRCL_ERP_PartialShipAllowed_t |
Boolean |
Indicates whether partial shipment of the requested quantity is acceptable to the customer. |
Partial Ship Allowed Flag |
partialShipAllowedFlag_t |
Boolean |
Indicates whether partial shipment of the requested quantity is acceptable to the customer. |
Partner Transaction ID |
oRCL_SFA_TransactionID_t |
Text |
The ID generated by SFA to identify this transaction. |
Payment Terms |
paymentTerms_t |
Menu |
The payment terms the customer will receive on their invoice. |
PO Number |
purchaseOrderNumber_t |
Text |
The purchase order number provided by the customer. |
Price Expiration Date |
priceExpirationDate_t |
Date |
The date the price quote will expire. |
Price Score |
priceScore_t |
Integer |
The total calculated price score for this transaction, based on an average weighted price score on each line based upon total Contract Value at List price. |
Price Score List Based |
_s_priceScoreListBased_t |
Integer |
Price 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 'Price Score Set'. |
Price Score Margin Based |
_s_priceScoreMarginBased_t |
Integer |
Price 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 'Price Score Set'. |
Price Score Simple Margin Based (List Price Basis) |
_s_priceScoreSimpleMarginListPrice_t |
Integer |
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 'Price Score Set'. |
Price Score Simple Margin Based (Net Price Basis) |
_s_priceScoreSimpleMarginNetPrice_t |
Integer |
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 'Price Score Set'. |
Price Score Simple Margin Based (Unit Cost Basis) |
_s_priceScoreSimpleMarginUnitCost_t |
Integer |
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 'Price Score Set'. |
Price Type |
priceType_t |
Menu |
Indicates whether the amount on this transaction is charged once or periodically. |
Price Within Policy |
priceWithinPolicy_t |
Boolean |
Indicates whether the prices in this transaction are all within their discount authority. |
Primary Flag |
primaryFlag_t |
Boolean |
Indicates that this quote is used as the basis for updating revenues on an associated opportunity. |
Primary Org ID |
oRCL_SFA_PrimaryOrgID_t |
Text |
The primary organization in SFA associated with this transaction or owner. |
Proposal Exists |
proposalExists_t |
Boolean |
Indicates whether the transaction has Proposal Document that can be viewed within the CRM or other integrated system. |
Quote for Agreement |
_s_quoteForAgreement_t |
Boolean |
Indicates whether the transaction is used as a Sales Agreement |
Reject Explanation |
rejectExplanation_t |
Text Area |
A detailed, free-form explanation of why the customer rejected the deal. |
Reject Reason |
rejectReason_t |
Menu |
The reason expressed by customer for rejecting this deal. The reason is selected by the sales user from a list of standard values for the site. |
Renew Draft Subscription Number |
renewDraftSubscriptionNumber_t |
Text |
Subscription management contract ID for the draft subscription used in the renewal process. |
Renewal Error Email Address |
renewalErrorEmailAddress_t |
Text |
The email address to be used to report an error in the automated renewal process. A distribution list email should be used if a department or group is to be notified. |
Renewal Process |
renewalProcess_t |
Menu |
The renewal process to be followed for a subscription billing-related transaction (i.e. automatic, manual, etc.). For non-subscription billing-related transactions, this value will be null. |
Renewal Process Used |
renewalProcessUsed_t |
Menu |
The renewal process used in creating this subscription billing-related transaction. |
Require Approval If Checked |
requireApprovalIfChecked_temporary_t |
Boolean |
This attribute is exposed only to the Administrator to assist in debugging of approval flows. Checking and unchecking the attribute allows the Administrator to more easily test flows requiring or not requiring approvals. |
Revenue Category |
_revenueCategory_t |
Revenue Category |
Identifies the category of revenue for this sales transaction (E.g. renewal vs new business). |
Sales Channel |
salesChannel_t |
Menu |
The channel that originated the transaction. |
Ship To Party ID |
_s_shipToPartyID_t |
Text |
The Party ID for the Ship To Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Invoice To Party may differ from the CRM Customer, Sold To, and Invoice To Parties. |
Ship To Party Site ID |
_s_shipToPartySiteID_t |
Text |
The ID for the Party Site or Address of the Ship To party. |
Skip Seller Review |
_s_skipSellerReview_t |
Boolean |
The 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. |
Sold To Customer Account ID |
_s_soldToCustomerAccountID_t |
Text |
The unique internal identifier for the Sold To Customer Account used for credit checking and collections. The Sold To Customer Account is typically mastered in an external ERP or Financials system and referenced when CPQ integrates sales orders to these systems. A Sold To Customer Account is typically associated to a Bill To address but may be associated with more than one. |
Sold To Party ID |
_s_soldToPartyID_t |
Text |
The Party ID for the Sold To Party / ERP Customer. This attribute is used when a generalized Party object is used to identify customer parties. The Sold To Party / ERP Customer may differ from the CRM Customer Party. |
Sold To Party Name |
_s_soldToPartyName_t |
Text |
TCA account integration provides value from PartyName to this field based on Customer Id and Business Unit ID |
Sold To Party Site ID |
_s_soldToPartySiteID_t |
Text |
The ID for the Party Site or Address of the Sold To party. |
Source Of Transaction |
_s_transactionSource_t |
Menu |
The business entity that initiated this transaction. |
Stage |
_stage |
Menu |
Identifies the current stage of a transaction. The allowable entries are "QUOTE", "ORDER", and "AGREEMENT". |
Status |
status_t |
Menu |
The most advanced milestone reached by lines of this transaction. |
Subscription ID |
_s_subscriptionId_t |
Text |
The identifier of the subscription contract. |
Subscription Status |
subscription_Status_t |
Text |
The status of the subscription order |
Subscription Profile Id |
subscriptionProfileId_t |
Text |
Customer subscription profile identifier to be used in subscription management to specify subscription contract preferences. |
Total (List) |
totalOneTimeListAmount_t |
Currency |
The total of all one-time charges on the lines. |
Total (List) Per Month |
totalMonthlyListAmount_t |
Currency |
The total of all monthly recurring list amounts on the lines. |
Total (Net) |
totalOneTimeNetAmount_t |
Currency |
The total one time net charge. |
Total (Net) Per Month |
totalMonthlyNetAmount_t |
Currency |
The total of all monthly recurring net amounts on the lines. |
Total Contract Cost |
totalContractCostAmount_t |
Currency |
The total of all contract extended costs for this transaction over the duration of the contract, including all one-time and recurring costs. |
Total Contract Discount |
totalContractDiscount_t |
Currency |
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract. |
Total Contract Margin |
totalContractMarginAmount_t |
Currency |
The total of all contract extended margins for this transaction over the duration of the contract, including all one-time and recurring values. |
Total Contract Value (List) |
totalContractListValue_t |
Currency |
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). |
Total Contract Value (Net) |
totalContractValue_t |
Currency |
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. |
Total Discount |
totalOneTimeDiscount_t |
Currency |
The total of all extended discount amounts for one time pricing/charges. |
Total Discount % |
transactionTotalDiscountPercent_t |
Float |
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. |
Total Discount Per Month |
totalMonthlyDiscount_t |
Currency |
The total of discounts off monthly recurring charges. |
Total Monthly Cost |
totalMonthlyCostAmount_t |
Currency |
The total of extended costs for all monthly recurring charges for the transaction. This is the total cost incurred each month. |
Total Monthly Margin |
totalMonthlyMarginAmount_t |
Currency |
The total of extended margins for all monthly recurring charges for the transaction. |
Total MUR (Net) |
totalMonthlyUsageRev_t |
Currency |
The total of all monthly usage revenues net of all discounts for this transaction. |
Total One-Time Cost |
totalOneTimeCostAmount_t |
Currency |
The total of extended costs for all one-time charges for the transaction. |
Total One-Time Margin |
totalOneTimeMarginAmount_t |
Currency |
The total of extended margins for all one-time charges for the transaction. |
Total Recurring Revenue (Net) |
totalRecurRevenue_t |
Currency |
The total recurring revenues net of all discounts for this transaction. |
Total Transaction Margin % |
transactionMarginPercent_t |
Float |
The percentage of the total list price for which this transaction's margin accounts. |
Total Usage Revenue (Net) |
totalUsageRevenue_t |
Currency |
The total usage revenues net of all discounts for this transaction. |
Transaction Description |
transactionDescription_t |
Text |
Description of the CPQ Transaction. |
Transaction Internal ID |
bs_id |
Text |
Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site. |
Transaction Name |
transactionName_t |
Text |
Attribute which captures the user entered Transaction Name |
Transaction Number |
transactionID_t |
Text |
The number or public unique identifier of the transaction. |
Transaction Source System |
transactionSourceSystem_t |
Text |
The code used to identify CPQ as the source for this transaction. |
Transaction Total (Net) |
_transaction_total |
Currency |
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. |
Transaction Version User Key |
userKey_t |
Text |
The transaction ID and version number concatenated together to make a single user key value or Number that uniquely identifies this transaction version. |
Trigger Update Asset for Line Status |
triggerUpdateAssetForLineStatus_t |
Text |
List of line.status_l values which indicate that line has finished processing on FOM and is ready to move to asset in CPQ(pending other lines's status within same root). |
Use Transaction For Analytics? |
_s_useTransactionForAnalytics_t |
Boolean |
This is used as a filter attribute for analytics. When set to True, values in this transaction will be used by analytics. |
Version |
version_t |
Integer |
The transaction ID combined with the version number are the unique key for the document. When a transaction is versioned this number is incremented. This is the Commerce Process-defined Version that defaults to the CPQ-Platform-created Version Number (version_number_versionTransaction). |
Win Probability |
_s_winProbability_t |
Float |
Win Probability value returned from the WP analytic named 'Win Probability'. |
Win Probability Net Revenue Value Prediction |
_s_winProbRevPrediction_t |
Float |
Win Probability Net Revenue Value Predicted by the Price Optimization Analytic 'Optimized Discount%'. |
Win/Loss Status |
winLossStatus_t |
Menu |
The determining status of whether the transaction represents a won or a lost sale. This can be used in Deal Management analysis. |
Win Probability Without Optimization |
_s_winProbNoOptimization_t |
Read-only text or HTML |
Hold win probability without Optimization graph. |