Nue Object Model - Nue Lifecycle Manager

from capturing customer information and managing opportunities to processing orders, provisioning subscriptions / assets / entitlements, and facilitating renewals, nue lifecycle manager enhances sales productivity and enables a seamless customer experience this article outlines the object model of nue lifecycle manager as illustrated in the following diagram, nue lifecycle manager leverages and extends standard crm objects in salesforce, including account, opportunity, quote, order, asset, etc most of these objects also have their mirrored objects in nue's cloud services deployed external to salesforce at a high level, the following business flows are supported in nue lifecycle manager create quote a sales user creates a new quote for an opportunity, and add one or more products as quote line items into the quote the products can be standalone products or bundles of different revenue models, including recurring, one time, overage usage, credit burndown, credit approve quote and generate order form a quote may be auto approved or submitted for approval based on the discounting level applied once approved, the sales user can generate the order form and send the order form to customers for review and sign finalize and activate order when an order form is signed, the sales user can finalize the quote into an order, and activate the order optionally, when the sales user marks the opportunity as closed won, the opportunity's primary quote will be finazlied into an active order when a quote is finalized into an order, the quote's header information is copied into the order, and all quote line items are converted into order products of the order; when an order is activated, its order products wil be provisioned into subscriptions, assets, and entitlements, according to the product category of the order product manage customer lifecycle the sales user can view and manage a customer's orders, subscriptions, assets, entitlements, invoices, credits, usage, and revenue contracts in the customer lifecycle manager create change quote or order within the lifecycle manager, the sales user has the ability to submit change requests for subscriptions, assets, and entitlements these change requests may include various actions such as updating quantities, extending or reducing subscription durations, renewing subscriptions, and more the sales user can add these change requests in a designated change cart and proceed to checkout the changes by generating a change quote or order based on the contents of the change cart optionally, the sales user can associate the quote or order with a change opportunity, so that the delta arr, delta tcv and other critical metrics can be rolled back into the sales pipeline eachchange line the quote line item or the order product contains changes to the original subscriptions, assets or entitlements only however, we also generate asummary linethat represents the information after the changes are applied for instance, a subscription sub 00001 contains 100 users with $10 per user, from 01/01/2023 to 12/31/2023, having tcv $12,000 a change line is created to add 50 users with $10 per user, from 07/01/2023 to 12/31/2023, having tcv $6,000 a summary line is generated to contain 150 users, with $10 per user, from 01/01/2023 to 12/31/2023, having tcv $18,000 the summary line is for information only it is not meant for reporting or data analysis finalize and activate change order the sales user can follow a similar procedure to obtain approval for the change quote and generate an order form once the quote is approved and order form is signed by the customer, the sales user can finalize the quote into an active order when a change order is activated, for each change line, its associated subscription, asset or entitlement isversioned the following actions occur the original subscription, asset or entitlement (e g , version 1) is replicated into a copy as a historical record this historical record's status is set as expired the information on thesummary line(that contains the information after the change is applied) is copied into the original subscirption, asset or entitlement the version of the original subscription, asset or entitlement now increments by 1 anasset order productrecord is created that stores the association relationship between the change line and the subscription, asset or entitlement change order generally speaking, a change order captures changes of one or more existing active subscriptions, assets or entitlements the ‘changes’ captured include the delta in quantity of goods or services, subscription terms, and financial metrics, such as arr, cmrr, acv, tcv once a change order is activated, the quantity and the subscription term changes will be further used to fulfill products and provision services the financial delta amount captured will be used for metrics calculation, because it reflects the financial changes as well as the change date of the transaction a subscription, asset or entilement may go through many changes over time each change will create a new version of the subscription, asset or entitlment by querying the asset order product records, we can retrieve all the changes leading to each version of the subscription, asset or entitlement in conclusion, a change order is essentially not making a change directly to an order, but it is making changes to the subscriptions, assets, and entitlements provisioned from one or more previous orders these changes, once captured and activated, can be applied to create newer versions of these subscriptions, assets and entitlements lifecycle manager objects docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 customer represents an individual customer account, partner or organization api name customer salesforce api name account fields the following table outlines all fields of the customer object field name api name salesforce api name type description account number accountnumber accountnumber autonumber the auto numbered account number auto renew autorenew ruby autorenew c picklist determines if the subscriptions of a customer will be auto renewed by default available options are yes docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 opportunity represents a sales opportunity api name (this object only resides in salesforce) salesforce api name opportunity fields the following table outlines all fields of the opportunity object field name salesforce api name type description account name accountid lookup(customer) id of the customer account amount amount currency estimated total sale amount for opportunities with products, the amount is the sum of the related products close date closedate date date when the opportunity is expected to close created by createdbyid lookup(userprofile) created by user created date createddate datetime created date description description longtext text description of the opportunity product limit is 80 characters discount ruby discount c percentage the aggregated discretional discount (in percentage) applied to the line items discount amount ruby discountamount c currency the total discretional discount amount aggregated from all line items end date ruby subscriptionenddate c date the end date of recurring products or services in this opportunity, which is defaulted to the start date plus the term (in month) expected revenue expectedrevenue currency read only field that is equal to the product of the opportunity amount field and the probability you can’t directly set this field, but you can indirectly set it by setting the amount or probability fields last modified by lastmodifiedbyid lookup(userprofile) last modified by user last modified date lastmodifieddate datetime last modified date opportunity name name text the opportunity name opportunity owner ownerid lookup(userprofile) id of the user who has been assigned to work this opportunity opportunity record type recordtypeid picklist record type of opportunity price book pricebook2id lookup(pricebook) id of the price book that applies to this opportunity primary quote ruby primaryquote c lookup(quote) id of the primary quote of this opportunity propability (%) propability percent percent of estimated confidence in closing the opportunity record type text name of the record type stage stagename picklist name of the current opportunity stage start date ruby subscriptionstartdate c date the start date of the products or services of the opportunity subscription term ruby subscriptionterm c number(5, 11) the length of the subscription system discount ruby systemdiscount c percent the system discount percentage system discount amount ruby systemdiscountamount c currency the total system discount amount aggregated from all line items subtotal ruby subtotal c currency(15, 3) the total sub total aggregated from of all line items total price ruby totalprice c currency the total price aggregated from all line items tax ruby tax c currency the total tax amount from all line items type type picklist type of opportunity for example, existing business or new business docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 opportunity product represents a product or service you sell in a sales opportunity api name (this object only resides in salesforce) salesforce api name opportunitylineitem fields the following table outlines all fields of the opportunity product object note please note that nue creates the following custom fields that hold nue's pricing calculation logic to replace salesforce's standard fields with the same name discount salesforce standard field discount nue custom field ruby discount c sales price salesforce standard field unitprice nue custom field ruby salesprice c subtotal salesforce standard field subtotal nue custom field ruby subtotal c total price salesforce standard field totalprice nue custom field ruby totalprice c field name salesforce api name type description created by createdbyid lookup(userprofile) created by user created date createddate date time created date currency currencycode picklist the currency used for the products or services in the deal this field is available only when multi currency is enabled in the salesforce org delta acv ruby deltaacv c currency annual contractual value of this line item delta arr ruby deltaarr c currency contractual annual recurring revenue, effective in between start date and end date of this line item delta cmrr ruby deltacmrr c currency contractual monthly recurring revenue, effective in between start date and end date of this line item delta tcv ruby deltatcv c currency total contractual value of this line item line description description text(80) text description of the opportunity line item limit 80 characters discount ruby discount c percentageage the discretional discount (in percentage) applied to this line item discount amount ruby discountamount c currency the discretional discount amount applied to the line item end date ruby subscriptionenddate c date the end date of recurring products or services of this line item last modified by lastmodifiedbyid lookup(userprofile) last modified by user last modified date lastmodifieddate date time last modified date list price listprice currency corresponds to the unitprice on the pricebookentry that is associated with this line item, which can be in the standard price book or a custom price book net sales price ruby netsalesprice c currency the net sales price after the discretional discount is applied opportunity product name name text the opportunity line item name opportunity opportunityid lookup(opportunity) the opportunity id primary quote line ruby primaryquoteline c lookup(quotelineitem) the primary quote line id null if this opportunity does not have a primary quote product product2id lookup(product) the product id product code productcode text the product code product sku ruby productsku c text the product sku that must be unique across products quantity quantity decimal the product quantity start date ruby subscriptionstartdate c date the start date of the product or service of this line item, which is defaulted to the opportunity start date, but can be updated for different line items sales price ruby salesprice c currency the sales price of the product before the discretionary discount it is calculated as subtotal / quantity / subscription term for products with a recurring revenue model, otherwise it is calculated as subtotal / quantity subscription term ruby subscriptionterm c decimal the subscription term of the recurring product or service of this line item, measured by uom default value is 1 for a one time product; 1 if uom’s term dimension is year; 12 if uom’s term dimension is month subtotal ruby subtotal c currency the actual system defined price, taking all layers of price tags into consideration system discount ruby systemdiscount c percentageage the system discount percentageage resulted from applying all layers of price tags system discount amount ruby systemdiscountamount c currency the system discount amount resulted from applying all layers of price tags total amount ruby totalamount c currency the total amount of the line item, including tax amount total price ruby totalprice c currency the total price of the line item, not including tax amount unit of measure ruby uom c lookup(uom) references the uom of the product selected in this line docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 quote represents proposed prices, quantities and terms of products or services you sell in a sales deal api name (this object only resides in salesforce) salesforce api name quote fields the following table outlines all fields of the quote object field name salesforce api name type description account name accountid lookup(account) id of the account that’s associated with the quote actions ruby actions c formula (text) edit lines action that can be added to the list view of a quote acv ruby annualcontractvalue c formula (currency) the total acv aggregated from all quote line items auto renew ruby autorenew c checkbox indicates if recurring line items in this quote will be auto renewed by default billing address billingaddress address read only, compound form of the billing address (it is an address compound field) billing city billingcity string city for the order’s billing address up to 50 characters are allowed billing county billingcounty string country for the order's billing address up to 80 characters are allowed billing country code billingcountrycode picklist iso country code for the order’s billing address billing latitude billinglatitude double used with billinglongitude to specify the precise geolocation of a billing address acceptable values are numbers between –90 and 90 with up to 15 decimal places billing longitude billinglongitude double used with billinglatitude to specify the precise geolocation of a billing address acceptable values are numbers between –180 and 180 with up to 15 decimal places billing name billingname string entity that the order is billed to billing postal code billingpostalcode string postal code for the order’s billing address billing state billingstate string state for the order’s billing address up to 80 characters are allowed billing state code billingstatecode picklist iso state code for the order’s billing address billing street billingstreet text area street name for the order's billing address currency iso code currencyisocode picklist available only for organizations with the multicurrency feature enabled contains the iso code for any currency allowed by the organization if the organization has multicurrency and a pricebook2id specified on the quote, then the currency value of this field must match the currency of the pricebookentry objects that are associated with any quote line items it has this value is copied from the related opportunity and can't be changed contact name contactid lookup(contact) id of the contract associated with this quote contract contractid lookup(contract) id for the contract associated with the quote created by createdbyid lookup(user) created by user created date createddate date created date description description long text area(32000) the quote description discount % ruby discount c percent(7, 5) the discount (in percentage) that sales rep applies to the line item you can enter a number with or without the percent symbol you can use up to two decimal places we also call this ‘on the fly’ discount this discount amount triggers the recalculation of the discount this is replacing the standard, non editable discount standard field discount amount ruby discountamount c currency(15, 3) the discount amount, which is calculated as discount subtotal / 100 email email email the email end date ruby subscriptionenddate c date the end date, which is defaulted to the start date plus the term (in month or year) if the end date is updated, the term and subscription term are both re calculated accordingly expiration date expirationdate date the date when this quote is no longer valid fax fax fax the fax number is custom calculation needed ruby iscustomcalculationneeded c boolean indicates if custom backend price calculations are needed for this quote if this value is set to true (typically by a custom flow), when the user clicks ‘quick save’ on the line editor, the line editor will wait for the value of this field to turn back to false this field is only available in salesforce last modified by lastmodifiedbyid lookup(user) last modified user last modified date lastmodifieddate date last modified date line items lineitemcount roll up summary (count quote line item) the total number of line items list total ruby listtotal c currency(15, 3) the total list price, aggregated from quote line items make this a template quote ruby is template quote c checkbox indicates if this quote is a template quote a quote can be created from a template quote opportunity name opportunityid master detail(opportunity) references the opportunity owner name ownerid lookup(user,group) the quote owner, which defaults from the opportunity owner payment method ruby paymentmethod c picklist the payment method used for this quote payment methods ruby paymentmethods c picklist(multi select) the payment methods used for this quote if multiple payment methods are allowed payment term ruby paymentterm c picklist the payment term available values include due upon receipt net 15 net 30 net 45 net 60 phone phone phone the phone number price book pricebook2id lookup(pricebook2) references the price book used for this quote required primary quote ruby isprimaryquote c checkbox indicates if this quote is a primary quote the primary quote can be synchronized with the opportunity quote name name text(255) required name for the quote limit 225 characters quote number quotenumber auto number a system generated number that identifies the quote quote to quotetoaddress address quote to address quote to name quotetoname text(255) quote to name same as bill to contact ruby isshiptocontactsameasbilltocontact c checkbox indicates if ship to contact is the same as bill to contact same as billing address ruby isquoteaddresssameasbilling c checkbox indicates if quote to address is the same as bill to address same as billing address ruby isshippingaddresssameasbilling c checkbox indicates if shipping address is the same as billing address ship to shippingaddress address shipping address ship to contact ruby shiptocontact c lookup(contact) ship to contact ship to name shippingname text(255) ship to name shipping and handling shippinghandling currency(16, 2) shipping and handling cost start date ruby subscriptionstartdate c date the start date, which is defaulted to the quote start date, but can be updated for different quote lines status status picklist the status of the quote the standard options are draft, needs review, in review, approved, rejected, presented, accepted, denied subscription term ruby subscriptionterm c number(5, 11) the subscription term measured by uom default value is 1 for a one time product; 1 if uom’s term dimension is year; 12 if uom’s term dimension is month subscription term dimension ruby subscriptiontermdimension c picklist the subscription term dimension available values are month, year subtotal ruby subtotal c currency(15,3) the subtotal aggregated from all line items the subtotal is calculated as list total subtracted by system discount amount system discount ruby systemdiscount c percent(7, 5) the aggregated system discount percentage that is applied to each line item this is a nue specific field for example, the list price of product a in the selected price book is $10 assuming there is a discount tag offering 10% discount if over 10 units are purchased, the system discount will be 10% if the selected quantity is 11 and above system discount amount ruby systemdiscountamount c currency(15, 3) the total system discount amount of all line items tax tax currency(16, 2) the total tax amounts of the quote, aggregated from the tax amount all quote line items tcv ruby tcv c roll up summary (sum quote line item) the total tcv aggregated from all quote line items template quote ruby template quote c lookup(quote) references the template quote where this quote is copied from today's arr ruby todayarr c currency(15, 3) today's arr contributed from all recurring line items of this quote today's cmrr ruby todaycmrr c currency(15, 3) today's cmrr contributed from all recurring line items of this quote total amount ruby totalamount c currency(15, 3) total amount aggregated from the total amount of all quote line items total price ruby totalprice c currency(15, 3) total price aggregated from the total price of all quote line items note pricing fields nue creates the following custom fields that hold nue's pricing calculation logic to replace salesforce's standard fields with the same name discount salesforce standard field discount nue custom field ruby discount c subtotal salesforce standard field subtotal nue custom field ruby subtotal c total price salesforce standard field totalprice nue custom field ruby totalprice c nue also replaces grant total field with total amount (ruby totalamount c) field representing the total amount of the quote, which includes taxes the following pricing fields are aggregated from quote line items with line types inlineitemandrampitemonly quote line items with line type insummaryitemandsplititemare excluded from the aggregation discount, discount amount, system discount, system discount amount, subtotal, total price, tax, total amount, today's arr, today's cmrr, total tcv is syncing field nue replaces is syncing standard field with primay quotefield to indicate if the quote can be synchronized with the opportunity nue only syncs quote line items with line type inlineitemandrampitemto the opportunity as opportunity products caution do not use these 2 fields ("is syncing", "primary quote") together otherwise it would create an infinite triggering conditions in salesforce docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 quote line item represents the proposed price, quantity and term of a product or service included in a quote api name (this object only resides in salesforce) salesforce api name quotelineitem fields the following table outlines all fields of the quote line item object field name salesforce api name type description actual quantity ruby actualquantity c number(15, 3) the actual quantity of the product used for price calculation actual term ruby actualsubscriptionterm c number(5, 11) the subscription term measured by month default value is 1 for a one time product, and 12 for a recurring product auto renew ruby autorenew c checkbox indicates if this recurring line item will be auto renewed the default value is inherited from that of product, but can be changed at operational time billing period ruby billingperiod c picklist also known as billing cycle or billing frequency, which determines how often the customers will be billed, for example, monthly, quarterly, annual, etc available values include month quarter semi annual annual if left empty, the billing period of the line item will be defaulted from the value set for the customer, or the value set at the organization level billing timing ruby billingtiming c picklist determines whether customers are billed for the products or services before or after they are provided or consumed available values include in advance in arrears if left empty, the billing timing will default from the value set at the product level, or the value set at the organization level cancellation date ruby cancellationdate c date indicates the cancellation date of the subscription, if this line item is of recurring object model change asset id ruby changeassetid c text(80) the unique identifier of the assets in the general term (which include subscriptions, assets and entitlements) that this line item is making changes for this field is only meaningful when is change is true in nue, subscriptions, assets and entitlements are versioned so change asset id is constructed as the asset name concatenated with the asset version for example, the following is a change asset id of a subscription sub 000708 1 change asset type ruby changeassettype c picklist the type of assets being changed by this line item this field is only meaningful when is change is true available values include asset subscription entitlement change reference item ruby changereferenceorderitem c lookup(order product) references the order product this line item is making a reduction change for a reduction change refers to a change that introduces a negative arr, e g , a quantity reduction, a term reduction or a subscription cancellation this field is only meaningful when is change is true change type ruby changetype c picklist the type of the change this field is only meaningful when is change is true available values include renew subscription new product update quantity update term co term cancel reconfigure co term for evergreen update term for evergreen when is change is false, the change type field is null created by createdbyid lookup(user) created by user created date createddate date created date delta acv ruby deltaacv c currency(15, 3) the change in annual contractual value of this line item if the product has a recurring, usage or credit burndown model, it is equal to delta arr if the product has a one time or credit product model, it is equal to total price of this line delta arr ruby deltaarr c currency(15, 3) the change in annual recurring revenue of this line item, effective in between the start date and end date of this line item the value is null if the line item is of one time revenue model delta cmrr ruby deltacmrr c currency(15, 3) the change in contractual monthly recurring revenue of this line item, effective in between the start date and end date of this line item the value is null if the line item is of one time revenue model delta tcv ruby deltatcv c currency(15, 3) the change in total contractual value of this line item the value is null if the this line item is an evergreen subscription discount % ruby discount c percent(7, 5) the discount percentage that the sales user applies to the line item it's all called "on the fly", or discretionary discount discount amount ruby discountamount c currency(15, 3) the discount dollar amount discount amount and discount % can be calculated from each other end date ruby subscriptionenddate c date the end date, which is defaulted to the start date plus the term (in month) if the end date is updated, the term and subscription term are both re calculated accordingly included units ruby includedunits c number(10, 2) the units included for free for this line item is change ruby ischange c checkbox indicates if this line item is a change line that contains changes to an existing subscription, asset or entitlement last modified by lastmodifiedbyid lookup(user) last modified by user last modified date lastmodifieddate date last modified date line bucket ruby linebucket c lookup(line bucket) references to the associated line bucket a quote can be split into multiple line buckets, and one or more line items can be added to a line bucket please refer to quote and order split docid\ uywunaqmbqgsrpessui68 for more details line item description description text(255) the line item description line item number linenumber auto number the auto numbered line item umber line type ruby linetype c picklist indicates the type of the line item available values include product (lineitem) represents a regular product line item ramp (rampitem) represents a subscription ramp line item summary item (summaryitem) represents a summary line item split item (splititem) represents a split line item to gain a better understanding of the various line types, please consult this article understanding line types docid\ hqqnw6wuf4f5ljj7 bfdi list price ruby listprice c currency(15, 3) corresponds to the unitprice on the pricebookentry that is associated with this line item, which can be in the standard price book or a custom price book list total ruby listtotalprice c currency(15, 3) the list price multiplied by the quantity and the subscription term (if the product is not a one time product) lifecycle start date ruby lifecyclestartdate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing lifecycle end date ruby lifecycleenddate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing if it is null, the credit will not expire milestones ruby milestones c long text area(32000) if the line type is summary line, this field contains a json representation of the definition of all service milestones if the line type is ramp, this field contains the name of the milestone net sales price ruby netsalesprice c currency(15, 3) the net sales price of the product before any price tags and the discretionary discount are applied it is calculated as total price divided by quantity, then divided by subscription term for products with a recurring, overage usage or credit burndown revenue model, otherwise it is calculated as subtotal divided by quantity opportunity line item ruby opportunitylineitem c lookup(opportunity product) references to the associated opportunity product this field is populated when a primary quote is synchornized to the opportunity, and each quote line item is copied into an opportunity product parent quote line ruby parentid c lookup(quote line item) references to the parent quote line item, which is the parent line item in the bundle hierarchy price book entry pricebookentryid lookup(price book entry) references the price book entry used as list price for this line item product product2id lookup(product) references the product product name ruby productname c formula (text) the product name product option ruby productoption c lookup(product option) references to the associated product option, if this line item is a bundled or add on line item of a bundle product line product option quantity ruby productoptionquantity c number(15, 3) references to the quantity of the associated product option, if this line item is a bundled or add on line item of a bundle product line the value of this field defaults to the quantity of the product option at design time however, the user may enter a different value if the product option is editable quantity quantity number(10, 2) the quantity of the line item quote name quoteid master detail(quote) references the quote reconfigure effective date ruby reconfigureeffectivedate c date indicates the date when a bundle product is reconfigured this field is only meaningful when is change is true, and change type is reconfigure renewal term ruby defaultrenewalterm c number(5, 11) the length of the renewal term, measured in the term dimesion of the associated uom, e g , month, year root quote line ruby rootid c lookup(quote line item) references the root line item, if the line item is in a bundle hierarchiy sales price ruby salesprice c currency(15, 3) the sales price of the product before the discretionary discount is applied it is calculated as subtotal divided by quantity, then divided by subscription term for products with a recurring revenue model, otherwise it is calculated as subtotal divided by quantity sort order ruby sortorder c number(18, 0) the sort order of the line item the sort order is used for displaying the line items in the line editor split parent ruby splitparent c lookup(quote line item) reference the parent line item of the split line this field is populated when a single line item is split into 2 or more split lines start date ruby subscriptionstartdate c date the start date, which is defaulted to the start date on the header, but can be updated for different line items subscription term ruby subscriptionterm c number(5, 11) the subscription term, measured in the term dimension of the associated uom subtotal ruby subtotal c currency(15, 3) the subtotal, which is calculated as list total subtracted by system discount amount summary line item ruby summarylineitem c lookup(quote line item) references the summary line item, if this line item is a ramp line, or a change line item system discount % ruby systemdiscount c percent(7, 5) the system discount percentage, which is the percentage of system discount amount over list total system discount amount ruby systemdiscountamount c currency(15, 3) the system discount amount, which results from applying all applicable of price tags tax amount ruby taxamount c currency(15, 3) the tax amount, calculated from the tax code of the product, if the product is taxable tax company code ruby taxcompanycode c text the tax company code used for multi company taxations total amount ruby totalamount c currency(15, 3) the total amount of the line item, which is the total price plus the tax amount total price ruby totalprice c currency(15, 3) the total price of the line item, which is equal to the total subtracted by system discount amount and discount amount unit of measure ruby uom c lookup(uom) the unit of measure of this line item note pricing fields nue creates the following custom fields that hold nue's pricing calculation logic to replace salesforce's standard fields with the same name discount salesforce standard field discount nue custom field ruby discount c subtotal salesforce standard field subtotal nue custom field ruby subtotal c total price salesforce standard field totalprice nue custom field ruby totalprice c line bucket represents a set of quote line items or order products bucketed together for a purpose api name (this object only resides in salesforce) salesforce api name ruby linebucket c fields the following table outlines all fields of the line bucket object field name salesforce api name type docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 description acv ruby acv c currency(15, 3) total annual contractual value (acv) of all line items in the bucket bill to city ruby billingcity c text(40) the bill to city bill to country ruby billingcountry c text(80) the bill to country bill to postal code ruby billingpostalcode c text(20) the bill to postal code bill to state ruby billingstate c text(80) the bill to state bill to street ruby billingstreet c text(255) the bill to street billing account ruby billingaccount c lookup(account) references to the billing account of this line bucket by default, it is the same as the account of the associated quote or order created by createdbyid lookup(user) created by user created date createddate date created date discount amount ruby discountamount c currency(15, 3) the total discount amount of all lines in the line bucket is default bucket ruby isdefaultbucket c checkbox indicates if this line bucket is the default bucket when the user navigates to the split lines page of the quote or order flow, a default line bucket is created last modified by lastmodifiedbyid lookup(user) last modified user last modified date lastmodifieddate date last modified date line bucket name name text(80) the name of the line bucket list total ruby listtotal c currency(15, 3) the total list price of all lines in the line bucket order ruby order c lookup(order) references the order if this line bucket is split from an order owner ownerid lookup(user,group) the owner of the line bucket primary contact ruby primarycontact c lookup(contact) references the primary contact quote ruby quote c lookup(quote) references the quote if this line bucket is split from a quote ship to city ruby shippingcity c text(40) the ship to city ship to country ruby shippingcountry c text(80) the ship to country ship to postal code ruby shippingpostalcode c text(20) the ship to postal code ship to state ruby shippingstate c text(80) the ship to state ship to street ruby shippingstreet c text(255) the ship to street start date ruby startdate c date the start date of the line bucket subtotal ruby subtotal c currency(15, 3) the subtotal aggregated from all line items in the line bucket system discount amount ruby systemdiscountamount c currency(15, 3) the total system discount amount of all line items in the line bucket tax amount ruby taxamount c currency(15, 3) the total tax amount of all line items in the line bucket tcv ruby tcv c currency(15, 3) the total total contractual value (tcv) of all line items in the line bucket total amount ruby totalamount c currency(15, 3) the aggregated total amount from all line items in the line bucket total price ruby totalprice c currency(15, 3) the aggregated total price from all line items in the line bucket docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 order represents a booking transaction between a company and a customer to provision services or deliver products with contracted quantities, prices, and terms the order object and quote object share a similar set of fields a quote serves as a preliminary order, whereas an order, upon activation, becomes a confirmed booking transaction when a quote is finalized into an order, the fields in the quote are copied over to the corresponding fields in the order, using the same api names additionally, administrators have the flexibility to configure additional field mappings between the quote and order objects to configure quote and order fields mapping, admin users can login to nue app, and navigate to system settings → quotes and orders → quote and order attribute mappings active orders are transfered to nue for billing, collections, and revenue recognition api name order salesforce api name order fields the following table outlines all fields of the order object object name api name salesforce api name type description account name / customner customer accountid lookup(account) id of the account that’s associated with the quote account number accountnumber text(40) the account number actions ruby actions c formula (text) edit lines action that can be added to the list view of a quote activated by activatedbyid activatedbyid lookup(userprofile) the user who activated the order activateddate activateddate activateddate datetime the activated date of the order, also seen as the transaction date of the booking transaction acv orderacv ruby annualcontractvalue c formula (currency) the total acv aggregated from all quote line items auto renew ruby autorenew c checkbox indicates if recurring line items in this order will be auto renewed by default bill cycle day billcycleday ruby billcycleday c picklist determines when the order will be billed, for example, 1st of the month the invoice will then be prorated based on this date available values include 1st of month 2nd of month 30th of month 31st of month the "31st of month" option can be used to signify the final day of the month, irrespective of the actual number of days in that particular month billing period billingperiod ruby billingperiod c picklist also known as billing cycle or billing frequency, which determines how often the customers will be billed, for example, monthly, quarterly, annual, etc available values include month quarter semi annual annual if left empty, the billing period of the order will be defaulted from the value set for the customer, or the value set at the organization level billing address billingaddress billingaddress address read only, compound form of the billing address (it is an address compound field) billing city billingcity string city for the order’s billing address up to 50 characters are allowed billing county billingcounty string country for the order's billing address up to 80 characters are allowed billing country code billingcountrycode picklist iso country code for the order’s billing address billing latitude billinglatitude double used with billinglongitude to specify the precise geolocation of a billing address acceptable values are numbers between –90 and 90 with up to 15 decimal places billing longitude billinglongitude double used with billinglatitude to specify the precise geolocation of a billing address acceptable values are numbers between –180 and 180 with up to 15 decimal places billing postal code billingpostalcode string postal code for the order’s billing address billing state billingstate string state for the order’s billing address up to 80 characters are allowed billing state code billingstatecode picklist iso state code for the order’s billing address billing street billingstreet text area street name for the order's billing address cancellation date cancellationdate ruby cancelationdate c date the date when the order is canceled currency iso code currencyisocode currencyisocode picklist available only for organizations with the multicurrency feature enabled contains the iso code for any currency allowed by the organization if the organization has multicurrency and a pricebook2id specified on the order, then the currency value of this field must match the currency of the pricebookentry objects that are associated with any quote line items it has this value is copied from the related opportunity and can't be changed bill to contact billtocontactid billtocontactid lookup(contact) references the bill to contact company authorized by companyauthorizedbyid companyauthorizedbyid lookup(user) id of the user who authorized the account associated with the order company authorized date companyauthorizeddate companyauthorizeddate date the date on which your organization authorized the order created by createdby createdbyid lookup(user) created by user created date createddate createddate date created date customer authorized by customerauthorizedbyid customerauthorizedbyid lookup (contact) date on which the contact authorized the order customer authorized date customerauthorizeddate customerauthorizeddate date id of the contact who authorized the order discount % discount ruby discount c percent(7, 5) the discount (in percentage) that sales rep applies to the line item you can enter a number with or without the percent symbol you can use up to two decimal places we also call this ‘on the fly’ discount this discount amount triggers the recalculation of the discount this is replacing the standard, non editable discount standard field discount amount discountamount ruby discountamount c currency(15, 3) the discount amount, which is calculated as discount subtotal / 100 end date enddate ruby subscriptionenddate c date the end date, which is defaulted to the start date plus the term (in month or year) if the end date is updated, the term and subscription term are both re calculated accordingly external id ruby externalid c text(100) reserved to use to store external id is custom calculation needed ruby iscustomcalculationneeded c boolean indicates if custom backend price calculations are needed for this quote if this value is set to true (typically by a custom flow), when the user clicks ‘quick save’ on the line editor, the line editor will wait for the value of this field to turn back to false this field is only available in salesforce is split ruby issplit c boolean indicates if this order is also split into child orders grand total grandtotal ruby grandtotal c currency(15,3) the grand total, including total amount plus shipping and handling last modified by lastmodifiedby lastmodifiedbyid lookup(user) last modified user last modified date lastmodifieddate lastmodifieddate date last modified date line bucket ruby linebucket c lookup(line bucket) references the line bucket where this order is finalized from when a quote is split into multiple line bucket, each line bucket can be finalized into an individual order list total listtotal ruby listtotal c currency(15, 3) the total list price, aggregated from quote line items opportunity opportunityid opportunityid master detail(opportunity) references the opportunity associated to this order order owner ownerid ownerid lookup(user, group) the order owner, which defaults from the quote owner order placed date orderplaceddate ruby orderplaceddate c date the date when the order is placed or activated order reference number orderreferencenumber orderreferencenumber text(80) order reference number assigned to this order maximum size is 80 characters order start date orderstartdate effectivedate date the order start date, which defaults from the quote start date order end date enddate enddate date the order end date, which defaults from the quote end date order type ordertype type picklist the type of an order, which is fully customizable payment method paymentmethod ruby paymentmethod c picklist the payment method used for this order payment methods paymentmethods ruby paymentmethods c picklist(multi select) the payment methods used for this order if multiple payment methods are allowed payment term ruby paymentterm c picklist the payment term available values include due upon receipt net 15 net 30 net 45 net 60 po date podate podate date date of the purchase order po number ponumber ponumber text(80) number identifying the purchase order maximum is 80 price book pricebookid pricebook2id lookup(pricebook) references the price book associated withis this order required quote quoteid lookup(quote) references the quote where this order finalizes from same as bill to contact ruby isshiptocontactsameasbilltocontact c checkbox indicates if ship to contact is the same as bill to contact same as billing address isshippingaddresssameasbilling ruby isshippingaddresssameasbilling c checkbox indicates if shipping address is the same as billing address shipping address shippingaddress shippingaddress address shipping address ship to contact shiptocontactid shiptocontactid lookup(contact) ship to contact shipping and handling shippingandhandling ruby shippinghandling c currency(16, 2) shipping and handling cost start date subscriptionstartdate ruby subscriptionstartdate c date the start date, which is defaulted from the quote start date, but can be updated for different order products status status status picklist the status of the order the available values include draft activated canceled subscription term subscriptionterm ruby subscriptionterm c number(5, 11) the subscription term measured by uom default value is 1 for a one time product; 1 if uom’s term dimension is year; 12 if uom’s term dimension is month subscription term dimension ruby subscriptiontermdimension c picklist the subscription term dimension available values are month, year subtotal subtotal ruby subtotal c currency(15,3) the subtotal aggregated from subtotal of all lines subtotal is calculated as list total subtracted by the system discount amount system discount systemdiscount ruby systemdiscount c percent(7, 5) the aggregated system discount percentage that is applied to each line item this is a nue specific field for example, the list price of product a in the selected price book is $10 assuming there is a discount tag offering 10% discount if over 10 units are purchased, the system discount will be 10% if the selected quantity is 11 and above system discount amount systemdiscountamount ruby systemdiscountamount c currency(15, 3) the total system discount amount of all line items tax tax tax currency(16, 2) the total tax amounts of the quote, aggregated from the tax amount all quote line items tax company code taxcompanycode ruby taxcompanycode c text the tax company code used for multi company taxations tcv ruby tcv c roll up summary (sum quote line item) the total tcv aggregated from all quote line items today's arr ruby todayarr c currency(15, 3) today's arr contributed from all recurring line items of this quote today's cmrr ruby todaycmrr c currency(15, 3) today's cmrr contributed from all recurring line items of this quote total amount totalamount ruby totalamount c currency(15, 3) total amount aggregated from the total amount of all quote line items total price totalprice ruby totalprice c currency(15, 3) total price aggregated from the total price of all quote line items pricing fields nue creates the following custom fields that hold nue's pricing calculation logic to replace salesforce's standard fields with the same name discount salesforce standard field discount nue custom field ruby discount c subtotal salesforce standard field subtotal nue custom field ruby subtotal c total price salesforce standard field totalprice nue custom field ruby totalprice c order amount salesforce standard field totalamount nue custom field ruby totalamount c deprecated salesforce order fields nue does not use the following standard fields in the salesforce order object original order, reduction order order product represents the price, quantity, and subscription term of a contracted product or service in an order api name orderproduct salesforce api name orderitem fields the following table outlines all fields of the order object field name api name salesforce api name type description account id accountid id references the id of the customer actual quantity actualquantity ruby actualquantity c decimal the actual quantity of the product used for price calculation actual subscription term (term) actualsubscriptionterm ruby actualsubscriptionterm c decimal the subscription term measured by month default value is 1 for a one time product, and 12 for a recurring product asset assetid ruby assetid c id asset number assetnumber ruby assetnumber c text asset type assettype ruby assettype c picklist auto renew autorenew ruby autorenew c boolean indicates if this recurring line item will be auto renewed the default value is inherited from that of product, but can be changed at operational time billing period billingperiod ruby billingperiod c picklist also known as billing cycle or billing frequency, which determines how often the customers will be billed, for example, monthly, quarterly, annual, etc available values include month quarter semi annual annual if left empty, the billing period of the line item will be defaulted from the value set for the customer, or the value set at the organization level billing timing billingtiming ruby billingtiming c picklist determines whether customers are billed for the products or services before or after they are provided or consumed available values include in advance in arrears if left empty, the billing timing will default from the value set at the product level, or the value set at the organization level cancellation date cancellationdate ruby cancellationdate c date indicates the cancellation date of the subscription, if this line item is of recurring object model change asset id changeassetid ruby changeassetid c id the unique identifier of the assets in the general term (which include subscriptions, assets and entitlements) that this line item is making changes for this field is only meaningful when is change is true in nue, subscriptions, assets and entitlements are versioned so change asset id is constructed as the asset name concatenated with the asset version for example, the following is a change asset id of a subscription sub 000708 1 change asset type changeassettype ruby changeassettype c picklist the type of assets being changed by this line item this field is only meaningful when is change is true available values include asset subscription entitlement change reference item ruby changereferenceorderitem c lookup (order product) references the order product this line item is making a reduction change for a reduction change refers to a change that introduces a negative arr, e g , a quantity reduction, a term reduction or a subscription cancellation this field is only meaningful when is change is true change type changetype ruby changetype c picklist the type of the change this field is only meaningful when is change is true available values include renew subscription new product update quantity update term co term cancel reconfigure when is change is false, the change type field is null created by createdbyid createdbyid lookup (userprofile) created by user created date createddate createddate date time created date contract liability segment contractliabilitysegment ruby contractliabilitysegment c text(80) accounting code of the contract liability segment contract revenue segment contractrevenuesegment ruby contractrevenuesegment c text(80) accounting code of the contract revenue segment carves liability segment carvesliabilitysegment ruby carvesliabilitysegment c text(80) accounting code of the carves liability segment carves revenue segment carvesrevenuesegment ruby carvesrevenuesegment c text(80) accounting code of the carves revenue segment customer name ruby customername c formula (text) references the name of the associated account default renewal term defaultrenewalterm ruby defaultrenewalterm c decimal the length of the renewal term, measured in the term dimesion of the associated uom, e g , month, year delta acv deltaacv ruby deltaacv c currency the change in annual contractual value of this line item if the product has a recurring, usage or credit burndown model, it is equal to delta arr if the product has a one time or credit product model, it is equal to total price of this line delta arr deltaarr ruby deltaarr c currency the change in annual recurring revenue of this line item, effective in between the start date and end date of this line item the value is null if the line item is of one time revenue model delta cmrr deltacmrr ruby deltacmrr c currency the change in contractual monthly recurring revenue of this line item, effective in between the start date and end date of this line item the value is null if the line item is of one time revenue model delta tcv deltatcv ruby deltatcv c currency the change in total contractual value of this line item the value is null if the this line item is an evergreen subscription description description description long text the line item description discount discount ruby discount c percent the discount percentage that the sales user applies to the line item it's all called "on the fly", or discretionary discount discount amount discountamount ruby discountamount c currency the discount dollar amount discount amount and discount % can be calculated from each other end date enddate enddate date the end date, which is defaulted to the start date plus the term (in month) if the end date is updated, the term and subscription term are both re calculated accordingly id id id id the record id included units includedunits ruby includedunits c decimal the units included for free for this line item ischange ischange ruby ischange c boolean indicates if this line item is a change line that contains changes to an existing subscription, asset or entitlement last modified by lastmodifiedbyid lastmodifiedbyid lookup (userprofile) last modified by user last modified date lastmodifieddate lastmodifieddate date time last modified date line bucket ruby linebucket c reference(linebucket) references to the associated line bucket a quote can be split into multiple line buckets, and one or more line items can be added to a line bucket please refer to quote and order split article for more details line type linetype ruby linetype c picklist indicates the type of the line item available values include product (lineitem) represents a regular product line item ramp (rampitem) represents a subscription ramp line item summary item (summaryitem) represents a summary line item split item (splititem) represents a split line item for more information about line types, please refer to this article understanding line types list price listprice ruby listprice c currency corresponds to the unitprice on the pricebookentry that is associated with this line item, which can be in the standard price book or a custom price book list total price listtotalprice ruby listtotalprice c currency the list price multiplied by the quantity and the subscription term (if the product is not a one time product) lifecycle start date lifecyclestartdate ruby lifecyclestartdate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing lifecycle end date lifecycleenddate ruby lifecycleenddate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing if it is null, the credit will not expire milestones n/a (this field only exists in salesforce) ruby milestones c long text area (32000) if the line type is summary line, this field contains a json representation of the definition of all service milestones if the line type is ramp, this field contains the name of the milestone net sales price netsalesprice ruby netsalesprice c currency the net sales price of the product before any price tags and the discretionary discount are applied it is calculated as total price divided by quantity, then divided by subscription term for products with a recurring, overage usage or credit burndown revenue model, otherwise it is calculated as subtotal divided by quantity order orderid orderid bmasterdetail references the order order product number name orderitemnumber autonumber the auto numbered line item number parent order product parentorderproductid ruby parentid c lookup (orderproduct) references to the parent line item, which is the parent line item in the bundle hierarchy price book pricebookid pricebookentry pricebook2id id references the price book pricebook entry pricebookentryid pricebookentryid id references the price book entry id used for the list price of this line item product productid product2id id references the product product name productname ruby productname c text the product name product option productoptionid ruby productoption c id references to the associated product option, if this line item is a bundled or add on line item of a bundle product line product option quantity productoptionquantity ruby productoptionquantity c decimal references to the quantity of the associated product option, if this line item is a bundled or add on line item of a bundle product line the value of this field defaults to the quantity of the product option at design time however, the user may enter a different value if the product option is editable quote line item quotelineitemid lookup(quote line item) references the associated quote line item quantity quantity quantity decimal the quantity of the line item reconfigure effective date ruby reconfigureeffectivedate c date indicates the date when a bundle product is reconfigured this field is only meaningful when is change is true, and change type is reconfigure revenue contract id revenuecontractid ruby revenuecontractid c text(200) indicates the grouping of customer contracts in revenue recognition root order product rootorderproductid ruby rootid c lookup (orderproduct) references the root line item, if the line item is in a bundle hierarchiy sort order sortorder ruby sortorder c integer the sort order of the line item the sort order is used for displaying the line items in the line editor split parent ruby splitparent c lookup (orderproduct) reference the parent line item of the split line this field is populated when a single line item is split into 2 or more split lines subscription end date subscriptionenddate ruby subscriptionenddate c date the end date, which is defaulted to the start date plus the term (in month) if the end date is updated, the term and subscription term are both re calculated accordingly subscription start date subscriptionstartdate ruby subscriptionstartdate c date the start date, which is defaulted to the start date on the header, but can be updated for different line items subscription term subscriptionterm ruby subscriptionterm c decimal the subscription term, measured in the term dimension of the associated uom subtotal subtotal ruby subtotal c currency the subtotal, which is calculated as list total subtracted by system discount amount summary line item summarylineitemid ruby summarylineitem c lookup (orderproduct) references the summary line item, if this line item is a ramp line, or a change line item system discount systemdiscount ruby systemdiscount c percent the system discount percentage, which is the percentage of system discount amount over list total system discount amount systemdiscountamount ruby systemdiscountamount c currency the system discount amount, which results from applying all applicable of price tags tax tax ruby tax c currency the tax amount, calculated from the tax code of the product, if the product is taxable tax company code taxcompanycode ruby taxcompanycode c text the tax company code used for multi company taxations total amount totalamount ruby totalamount c currency the total amount of the line item, which is the total price plus the tax amount total price totalprice ruby totalprice c currency the total price of the line item, which is equal to the total subtracted by system discount amount and discount amount sales price unitprice ruby salesprice c currency the sales price of the product before the discretionary discount is applied it is calculated as subtotal divided by quantity, then divided by subscription term for products with a recurring revenue model, otherwise it is calculated as subtotal divided by quantity unit of measure uomid ruby uom c id the unit of measure of this line item docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 line price tag records the relationship between a line item (a quote line item, or an order product) and a price tag, representing which price tag(s) are applied to which line item(s), and their price impacts api name linepricedimension salesforce api name ruby linepricedimension c fields the following table outlines all fields of the line price tag object field name api name salesforce api name type description applied to children ruby appliedtochildren c boolean indicates if the price tag referenced by this line has been applied to children add on line items as well default to false created by createdbyid createdbyid lookup (userprofile) created by user created date createddate createddate date time created date id id id id the record id if effective ruby is effective c boolean indicates if the associated price tag is effective last modified by lastmodifiedbyid lastmodifiedbyid lookup (userprofile) last modified user last modified date lastmodifieddate lastmodifieddate date time last modified date name name name text (255) the name of the line price tag defaults to the name of the price tag object type ruby objecttype c picklist indicates the object type associated to this price tag available values include quotelineitem orderitem order ruby order c lookup(order) references the associated order, if object type is equal to orderitem order product orderproductid ruby orderitem c bmasterdetail references the associated order product, if object type is equal to orderitem parent id ruby parentid c lookup(line price tag) the id of the line price tag where this line price tag inherits from, when a discount tag is propagated to children add on lines from a bundle line this field is nullable price tag pricedimensionid ruby pricedimension c bmasterdetail references the associated price tag price impact ruby priceimpact c currency the price impact generated by the associated price tag over the line item quote ruby quote c lookup(quote) references the associated quote, if object type is equal to quotelineitem quote line item ruby quotelineitem c lookup(quotelineitem) references the associated quote line item, if object type is equal to quotelineitem serial number serialnumber ruby serialnumber c integer the order of the price tag being applied the price type price tag always has order 0, and other discount dimensions have order 1 n subscription represents a recurring product or service provisioned for a customer a subscription of a product bundle may have children subscriptions and other assets and entitlements api name subscription salesforce api name ruby subscription c fields the following table outlines all fields of the subscription object asset represents a physical asset fulfilled for a customer api name asset salesforce api name asset fields the following table outlines all fields of the asset object field name api name salesforce api name type description asset composite id assetcompositeid ruby assetcompositeid c text (50) asset number concatenated with the asset version asset level assetlevel assetlevel integer the asset’s position in an asset hierarchy if the asset has no parent or child assets, its level is 1 assets that belong to a hierarchy have a level of 1 for the root asset, 2 for the child assets of the root asset, 3 for their children, and so forth asset number assetnumber ruby assetnumber c autonumber the asset number, currently is populated as the id of the asset asset provided by id assetprovidedbyid assetprovidedbyid id references the account that provided the asset, typically a manufacturer asset serviced by id assetservicedbyid assetservicedbyid id references the account in charge of servicing the asset asset version assetversion ruby assetversion c decimal the asset version default to 1 billing period billingperiod ruby billingperiod c picklist also known as billing cycle or billing frequency, which determines how often the customers will be billed, for example, monthly, quarterly, annual, etc this field is copied from the corresponding order product when the order is activated available values include month quarter semi annual annual billing timing billingtiming ruby billingtiming c picklist determines whether customers are billed for the products or services before or after they are provided or consumed the field is copied available values include in advance in arrears cancellation date cancellationdate date contact id contactid contactid id created by createdbyid createdbyid lookup (userprofile) created date createddate createddate date time customer id customerid accountid lookup (customer) description description description long text external id externalid externalidentifier text (255) id id id id install date installdate installdate date internal asset internalasset isinternal boolean is competitor product iscompetitorproduct iscompetitorproduct boolean last modified by lastmodifiedbyid lastmodifiedbyid lookup (userprofile) last modified date lastmodifieddate lastmodifieddate date time last price lastprice decimal last versioned asset id lastversionedassetid id list price listprice decimal lifecycle start date lifecyclestartdate ruby lifecyclestartdate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing lifecycle end date lifecycleenddate ruby lifecycleenddate c date the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing if it is null, the credit will not expire location locationid locationid picklist name name name text (255) order product id orderproductid ruby orderproduct c lookup (orderproduct) original asset id originalassetid ruby originalasset c id parent asset id parentid ruby parentid c text (80) parent asset object parentassetobject ruby parentassetobject c picklist price price price currency price book entry id pricebookentryid ruby pricebookentry c text price book id pricebookid id product code productcode productcode text (255) product description productdescription productdescription long text product family productfamily productfamily picklist product id productid product2id text purchase date purchasedate purchasedate date quantity quantity quantity decimal reconfigure effective date reconfigureeffectivedate date root asset id rootid ruby rootid c text (80) sku sku stockkeepingunit text (180) sales price salesprice decimal serial number serialnumber serialnumber text (80) start date startdate date status status status picklist status reason statusreason statusreason picklist tcv tcv decimal tax amount taxamount decimal total acv totalacv decimal total amount totalamount decimal total price totalprice decimal total tcv totaltcv decimal unique identifier uniqueidentifier uuid text (255) uom id uomid ruby unitofmeasure c text usage end date usageenddate usageenddate date docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 entitlement represents a service entitlement provisioned for a customer api name entitlement salesforce api name ruby entitlement c fields the following table outlines all fields of the entitlement object field name api name salesforce api name description type billing period billingperiod ruby billingperiod c picklist billing timing billingtiming ruby billingtiming c picklist cancellation date cancellationdate ruby cancellationdate c date created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) created date createddate createddate the date when the record is created date time customer id customerid ruby customer c lookup ( customer docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) deleted isdeleted isdeleted boolean end date enddate ruby enddate c date entitlement composite id entitlementcompositeid ruby entitlementcompositeid c text (50) entitlement level entitlementlevel ruby entitlementlevel c decimal entitlement name name name text (80) entitlement number entitlementnumber ruby entitlementnumber c text (36) entitlement version entitlementversion ruby entitlementversion c decimal id id id the id of the record id last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time last versioned entitlement id lastversionedentitlementid ruby lastversionedentitlement c id list price listprice ruby listprice c currency lifecycle start date lifecyclestartdate ruby lifecyclestartdate c the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing date lifecycle end date lifecycleenddate ruby lifecycleenddate c the lifecycle start date and lifecycle end date define the period during which the credit is applicable for usage or invoicing if it is null, the credit will not expire date net sales price netsalesprice ruby netsalesprice c currency order number ordernumber ruby ordernumber c text order on date orderondate ruby orderondate c date order product id orderproductid ruby orderproduct c lookup ( orderproduct docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) original entitlement id originalentitlementid ruby originalentitlement c id original entitlement number originalentitlementnumber ruby originalentitlementnumber c text parent entitlement object parententitlementobject ruby parententitlementobject c picklist parent id parentid ruby parentid c text (80) price book entry id pricebookentryid ruby pricebookentry c text price book id pricebookid ruby pricebook c id product id productid ruby product c text product name text productname ruby productnametext c text (255) quantity quantity ruby quantity c decimal quantity dimension quantitydimension ruby quantitydimension c text reconfigure effective date reconfigureeffectivedate ruby reconfigureeffectivedate c date root id rootid ruby rootid c text (80) sales price salesprice ruby salesprice c currency start date startdate ruby startdate c date status status ruby status c picklist tcv tcv ruby tcv c currency tax amount taxamount ruby taxamount c currency tax company code taxcompanycode ruby taxcompanycode c the tax company code used for multi company taxations text term dimension termdimension ruby termdimension c text total acv totalacv ruby totalacv c currency total amount totalamount ruby totalamount c currency total price totalprice ruby totalprice c currency total tcv totaltcv ruby totaltcv c currency uom id uomid ruby unitofmeasure c text docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 asset order product records the relationship between a booking transaction (an order product) and an asset in the general term, which can be a physical asset, a subscription, and an entitlement api name assetorderproduct salesforce api name ruby assetorderproduct c fields the following table outlines all fields of the asset order product object field name api name salesforce api name description type asset id assetid ruby asset c id asset number assetnumber ruby assetnumber c text (80) asset type assettype ruby assettype c text asset version assetversion decimal asset version relation assetversionrelation text created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) created date createddate createddate the date when the record is created date time customer id customerid lookup ( customer docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) entitlement number serviceentitlementnumber ruby serviceentitlementnumber c text (80) entitlement version entitlementversion decimal entitlement version relation entitlementversionrelation text id id id the id of the record id isfromlatestsubscription isfromlatestsubscription boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time name name text (255) order product orderproductid ruby orderproduct c lookup ( orderproduct docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) subscription subscriptionid ruby subscription c lookup ( subscription docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) subscription number subscriptionnumber ruby subscriptionnumber c text (80) subscription version subscriptionversion ruby subscriptionversion c decimal subscription version relation subscriptionversionrelation text summary line item id summarylineitemid ruby summarylineitemid c lookup ( orderproduct docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 ) docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 auto renewal status when the auto renewal job runs, not only the failed records, but also the successfully renewed records, will be persisted in the auto renewal status object for track records api name n/a this object is only available in salesforce, and is reportable salesforce api name ruby autorenewalstatus c fields the following table outlines all fields of the auto renewal status object field name api name description type name name the auto numbered name text (auto number)pattern ars {000000000} job id ruby jobid c the auto renewal job id text(255) renewal date ruby renewaldate c the data when the record is auto renewed date subscription id ruby subscription c the latest version of the subscription being renewed lookup(subscription) subscription number ruby subscriptionnumber c the subscription number this is the subscription number of the latest version, for subscriptions that are either successfully renewed, or failed in renewal formula subscription version ruby subscriptionversion c the latest version of the subscription this is for both subscriptions that are either successfully renewed, or failed in renewal formula status ruby status c the renewal status available values are success, failure picklist ( non restricted ) status message ruby statusmessage c the renewal status message note that even successful renewals may also log status messages this field should be used together with the status field the status message will be truncated to 255 characters text(255) error trace ruby errortrace c the error stack trace, if there is any long text (25535) docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4 docid 6e03d37fbe21ff7302fc1fd62292cf3bd9d513c4