Nue Knowledge Center

Nue Docs navigation

Get Started

Configure Products and Prices Create Quotes and Orders Upsell and Renew Subscriptions Understanding Price Calculations Understanding Subscription Term Basis and Proration Ask Nue!

Use Cases

Authenticate API Users Refresh the Salesforce Sandbox

Price Builder

Products Price Book Unit of Measure (UOM)Price and Discount Tags Product Bundle Product Group Product Relationships Percent of Total Multi-attribute Pricing Multiple Currencies Manage Custom Attributes in Price Book Entries Quantity Tier Attributes for Price Tags

Object Model

Nue Object Model Overview Nue Object Model - Price Builder Nue Object Model - Lifecycle Manager Nue Object Model - Billing and Usage Accelerator Understanding Line Types Nue Object Model - Revenue Lifecycle Intelligence

Tutorial

Price Builder Quote Builder Lifecycle Manager Collections Everything Billing Usage Accelerator Lifecycle Intelligence The Nue Platform Integrations Frequently Asked Questions

Lifecycle Manager

Configure Renewal Opportunity Process Configure Create Opportunity Popup Import Subscriptions into Nue Nue Sales Console

Quote Builder

Quote Builder Overview Quote and Order Split Quote Approval Sync Primary Quote to Opportunity Template Quote Manage Filters

Lifecycle Manager

Lifecycle Manager Overview Upsell and Downsell Renew Subscriptions Co-Term Subscriptions Cross-Sell Reconfigure Bundle Subscriptions Adjust Prices Evergreen Subscriptions Cancel Subscriptions Cancel Orders Preview Invoices Manage Service Milestones and Milestone-based Billing

Nue Platform

Manage Custom Fields Product Search Plugin Lookup Filter Plugin Default Value Plugin Invoice Preview Plugin Query Nue Objects using GraphQL Price Tag Search Plugin

Use Cases

Subscription Ramp Pricing Configure Pricing for Different Billing Periods Billing Account Search Setting a Price Floor Revenue Sharing with Partners Custom Payment Terms Update Order Information Customize Auto-numbering Schemes

Everything Billing

Billing Accelerator Overview Billing Parameters Billing Schedules Invoice Status Explained Credit Memos Late Fees - a Debit Memo Use Case Catch-up Bill Run Billing Account Hierarchy Scheduled Sync Jobs Billing Groups Multiple Entities

Collections

Collections Overview Collections Scenarios - Invoicing Collections Scenarios - Credit Memos and Debit Memos Collections Scenarios - Payments Collections Scenarios - Refunds and Reversals Collections Scenarios - Write Off Payment Rules

How-to Guide

Lifecycle Manager Nue Platform

Usage Accelerator

Usage Accelerator Overview The Credit Burndown Usage Model Multiple Credit Pools Credit Proration One-time Credits Integrate with Existing Usage Systems

Developer Resources

Use Cases Object Model API Reference Apex Global Services Self-Service API Guide Client Side Pricing Engine

Lifecycle Intelligence

Revenue Lifecycle Intelligence Subscription and Order Metrics ARR Momentum Booking Dashboard Pipeline Dashboard Billing and Collections Dashboard

Support

Submit a support ticket

The Nue Platform

System Settings Platform Settings Lifecycle Manager Settings Price Builder Settings Billing and Usage Settings Nue Security API Keys Roles and Permissions Export and Import Understanding Data Storage and Synchronization

Integrations

Nue on Salesforce Nue on Salesforce Permission Sets Stripe Integration DocuSign Integration QuickBooks Integration NetSuite Integration - ARM Connector Recognize Revenue via RightRev Calculate Taxes via Avalara Integration Calculate Taxes via Stripe Tax Webhooks Update Nue Integration User for Salesforce Integration Nue on Salesforce Layout Configurations NetSuite Integration v2023 NetSuite Integration Setup NetSuite Connector - Fields Mapping Streamlined E-Invoicing with Avalara ELR

Home

Developer Resources/Object Model

Nue Object Model - 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.

Object Model Overview - 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.
Each Change Line - the quote line item or the order product - contains changes to the original subscriptions, assets or entitlements only. However, we also generate a Summary Line that 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 is versioned. 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 the Summary 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.
- An Asset Order Product record 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

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 No Default to Subscription Configuration
Bill Cycle Date	billCycleDay	Ruby__BillCycleDay__c	PickList	Determines on which day the billing cycle starts. There is an organizational default Bill Cycle Day, but can be overridden at the customer level.
Billing City	billingCity	BillingCity	Text	The City of the billing address.
Billing Country	billingCountry	BillingCountry	Text	The Country of the billing address.
Billing State	billingState	BillingState	Text	The State of the billing address.
Billing Street	billingStreet	BillingStreet	Text	The Street of the billing address.
Billing ZipCode	billingZipCode	BillingZipCod	Text	The Zip Code of the billing address.
Created By	createdById	CreatedById	Lookup (UserProfile)	The created-by user.
Created Date	createdDate	CreatedDate	Date Time	The created date.
Customer Id	id	Id	ID	The customer ID.
Customer Name	name	Name	Text (255)	The customer name.
Customer Since	customerSince	Ruby__CustomerSince__c	Date	The date when the first order of this customer is activated.
Description	description	Description	Long Text	The customer description.
Fax	fax	Fax	Phone	The fax number.
Industry	industry	Industry	PickList	The customer industry.
Invoice Balance	invoiceBalance	Ruby__InvoiceBalance__c	Currency	The total invoice balance of this customer.
Last Invoice Date	lastInvoiceDate	Ruby__LastInvoiceDate__c	Date	The date when the last invoice was generated.
Last Modified By	lastModifiedById	LastModifiedById	Lookup (UserProfile)	The last modified user.
Last Modified Date	lastModifiedDate	LastModifiedDate	Date Time	The last modified date.
Latest Order Date	latestOrderDate	Ruby__LatestOrderDate__c	Date	The date when the last order was placed and activated.
Parent Customer	parentCustomerId	ParentId	ID	The parent customer ID if there exists an account hierarchy for this customer.
Phone	phone	Phone	Phone	The phone number.
Record Type	recordType	Ruby__AccountRecordType__c	PickList	The customer record type. Available values include : Business Consumer
Sales Account	salesAccountId	Ruby__SalesAccount__c	Lookup(Customer)	The associated sales account of this billing account.
Shipping City	shippingCity	ShippingCity	Text	The City of the shipping address.
Shipping Country	shippingCountry	ShippingCountry	Text	The Country of the shipping address.
Shipping State	shippingState	ShippingState	Text	The State of the shipping address.
Shipping Street	shippingStreet	ShippingStreet	Text	The Street of the shipping address.
Shipping Zip Code	shippingZipCode	ShippingZipCode	Text	The Zip Code of the shipping address.
Today's ARR	todayARR	Ruby__TodayARR__c	Currency	Total contractual ARR contributed by this customer today.
Today's CMRR	todayCMRR	Ruby__TodayCMRR__c	Currency	Total contractual MRR contributed by this customer today.
Total TCV	totalTCV	Ruby__TotalTCV__c	Currency	Total contract value of all active orders.

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.

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.

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 in LineItem and RampItem only. Quote line items with line type in SummaryItem and SplitItem are 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 Quote field to indicate if the quote can be synchronized with the opportunity. Nue only syncs quote line items with line type in LineItem and RampItem to 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.

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 article for more details.
Line Item Description	Description	Text(255)	The line item description.
Line Item Number	LineNumber	Auto Number	The auto-numbered line item number.
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.
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	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	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.
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	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.

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.
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.
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.

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
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.
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.

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.

FIELD NAME	API NAME	SALESFORCE API NAME	TYPE	DESCRIPTION
Auto Renew	autoRenew	Ruby__AutoRenew__c	Boolean	Indicates if the subscription will be auto-renewed. Defaults to false. Please refer to Auto Renew for more details about subscription auto renewal.
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
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
Cancellation Date	cancellationDate	Ruby__CancellationDate__c	Date	The date when the subscription will be or was cancelled.
Created By	createdById	CreatedById	Lookup (UserProfile)	The created by user.
Created Date	createdDate	CreatedDate	Date Time	The created date.
Customer Id	customerId	Ruby__Customer__c	ID	The customer ID.
Id	id	Id	ID	The record ID.
Included Units	includedUnits	Ruby__IncludedUnits__c	Decimal	The quantities that are incldued with no charge in this subscription.
Last Modified By	lastModifiedById	LastModifiedById	Lookup (UserProfile)	The last modified user.
Last Modified Date	lastModifiedDate	LastModifiedDate	Date Time	The last modified date.
Last Versioned Subscription Id	lastVersionedSubscriptionId	Ruby__LastVersionedSubscription__c	Lookup (Subscription)	The last versioned subscription. For example, if the current subscription has version 3, the last versioned subscription is the subscription having the same original subscription ID, but has the subscription version 2.
List Price	listPrice	Ruby__ListPrice__c	Currency	The list price of the product or service for this subscription.
Order On	orderOnDate	Ruby__OrderOnDate__c	Date	The date when the subscription is ordered on.
Order Product Id	orderProductId	Ruby__OrderProduct__c	Lookup (OrderProduct)	References the order product (i.e. order line item) where this subscription is provisioned from.
Original Subscription Id	originalSubscriptionId	Ruby__OriginalSubscription__c	Lookup (Subscription)	References the original subscription. It is the current subscription, if the Subscription Version Number is 0.
Original Subscription Number	originalSubscriptionNumber	Ruby__OriginalSubscriptionNumber__c	Text	The original subscription number.
Parent Subscription Id	parentId	Ruby__ParentId__c	Text (80)	ID of the parent subscription
Parent Subscription Object	parentSubscriptionObject	Ruby__ParentSubscriptionObject__c	PickList	The parent object of the subscription. Available values include: Subscription Asset Entitlement Currently, the parent object of a subscription may only be a subscription.
Price Book Entry Id	priceBookEntryId	Ruby__PriceBookEntry__c	ID	ID of the associated price book entry.
Price Book Id	priceBookId	Ruby__PriceBook__c	ID	ID of the associated price book.
Product Id	productId	Ruby__Product__c	Lookup (Product)	References the associated product.
Quantity	quantity	Ruby__Quantity__c	Decimal	The quantity of the product or services in this subscription.
Reconfigure Effective Date	reconfigureEffectiveDate	Ruby__ReconfigureEffectiveDate__c	Date	Indicates the date when the subscription, which has a bundle product, is reconfigured.
Renewal Term	renewalTerm	Ruby__RenewalTerm__c	Decimal	Indicates the renewal term of the subscription.
Root Subscription Id	rootId	Ruby__RootId__c	Text (80)	ID of the root subscription, if the current subscription is in a bundle hierarchy.
Sales Price	salesPrice	Ruby__SalesPrice__c	Currency	The Sales Price of the subscription.
Status	status	Ruby__Status__c	PickList	Subscription Status. Available values are: Draft Active Cancelled Expired (Note: An expired subscription refers to an older version of a subscription).
Subscription Composite Id	subscriptionCompositeId	Ruby__SubscriptionCompositeId__c	Tax(80)	Subscription number concatenated with the subscription version, in the following format: SUB-{000001}-{SubscriptionVersion}
Subscription End Date	subscriptionEndDate	Ruby__SubscriptionEndDate__c	Date	The subscription end date. This value is copied from that of the Order Product.
Subscription Level	subscriptionLevel	Ruby__SubscriptionLevel__c	Decimal	Refers to the position or ranking of a subscription within a hierarchical bundle structure. For instance, if a subscription is categorized as a child subscription under a parent subscription, where the parent subscription is at the topmost level, the subscription level would be denoted as 2.
Subscription Number	name	Name	AutoNumber	Subscription number assigned to the Subscription. The default auto-number format is: `SUB-{000001}`
Subscription Start Date	subscriptionStartDate	Ruby__SubscriptionStartDate__c	Date	The subscription start date. This value is copied from that of the Order Product when the order is activated.
Subscription Term	subscriptionTerm	Ruby__SubscriptionTerm__c	Decimal	The Subscription Term measured by UOM. This value is copied from that of the Order Product when the order is activated. The default value is: 1, if this subscription contains a one-time product; Null, if this subscription is an evergreen subscription; Otherwise, 1 if UOM’s Term Dimension is Year; 12 if UOM’s Term Dimension is Month.
Subscription Version	subscriptionVersion	Ruby__SubscriptionVersion__c	Integer	The subscription version. The default value is 1.
TCV	tcv	Ruby__TCV__c	Decimal	Total Contractual Value of the subscription.
Tax Amount	taxAmount	Ruby__TaxAmount__c	Currency	The tax amount.
Term	actualSubscriptionTerm	Ruby__ActualSubscriptionTerm__c	Decimal	The subscription term measured by Month. Default value is 1 for a One-Time product, null for an evergreen subscription, and 12 for a recurring product.
Today's ARR	todayARR	Ruby__TodayARR__c	Currency	Total contractual Annual Recurring Revenue contributed by this subscription today, which is Calculated by summarizing the Delta ARR from all the associated activated order products, where `Subscription Start Date <= Today <= Subscription End Date`
Today's CMRR	todayCMRR	Ruby__TodayCMRR__c	Currency	Total contractual Monthly Recurring Revenue contributed by this subscription today, which is Calculated by summarizing the Delta CMRR from all the associated activated order products, where `Subscription Start Date <= Today <= Subscription End Date`
Today's Quantity	todaysQuantity	Ruby__TodaysQuantity__c	Currency	Today's contracted product or service quantity, which is calculated by summarizing the Delta Quantity from all the associated activated order products, where `Subscription Start Date <= Today <= Subscription End Date`
Total ACV	totalACV	Ruby__TotalACV__c	Currency	The aggregated ACV of this subscription as well as all its children assets, including subscriptions, assets and entitlements.
Total Amount	totalAmount	Ruby__TotalAmount__c	Currency	The total amount of the subscription, with tax included.
Total Price	totalPrice	Ruby__TotalPrice__c	Currency	The total price of the subscription.
Total TCV	totalTCV	Ruby__TotalTCV__c	Currency	The aggregated TCV of this subscription as well as all its children assets, including subscriptions, assets and entitlements.
UOM Id	uomId	Ruby__Uom__c	ID	ID of the associated UOM.
bundled	bundled	Ruby__Bundled__c	Boolean	Indicates if this subscription is a bundled subscription (i.e., with 0 sales price) of the parent bundle subscription.

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

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)
Created Date	createdDate	CreatedDate	The date when the record is created	Date Time
Customer Id	customerId	Ruby__Customer__c		Lookup (Customer)
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)
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)
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
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

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)
Created Date	createdDate	CreatedDate	The date when the record is created	Date Time
Customer Id	customerId			Lookup (Customer)
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)
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)
Subscription	subscriptionId	Ruby__Subscription__c		Lookup (Subscription)
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)