Nue Knowledge Center

Nue Docs navigation

search
clear
/

Nue Object Model - Billing and Usage Accelerator

Nue Billing and Usage Accelerator stands out as a versatile solution capable of seamlessly generating invoices for a diverse range of products. Its strength lies in its ability to handle various billing scenarios, including physical goods, milestone-based services, subscriptions, and consumptions. What sets it apart is the incorporation of a unified object model, streamlining the invoicing process and ensuring consistency across different types of products. This innovative approach not only simplifies billing complexities but also enhances the overall efficiency of invoicing operations, making Nue Billing and Usage Accelerator a comprehensive tool for businesses with diverse product offerings.

 

This article outlines the object model of Nue Billing & Usage Accelerator.

 


 

Object Model Overview - Nue Billing & Usage Accelerator

As illustrated in the following diagram, Nue Billing & Usage Accelerator interfaces with Nue Lifecycle Manger and Price Building via objects including Account, Contact, Product, Order Product, etc.

 

Order-based Billing

Nue embraces the fundamental concept of order-based billing, considering the order as the primary monetary transaction within the traditional Lead-to-Cash flow. In the sale of physical goods, an order is initiated when a customer places a request, and the initial invoice is issued upon order placement or fulfillment. In cases of subsequent quantity adjustments from the same customer, a change order, essentially another order, is created, containing additional quantities and corresponding invoiced amounts.

 

In contrast, when dealing with recurring services like subscriptions and consumptions, many billing vendors generate invoices directly from subscriptions, bypassing the order-centric approach. This practice introduces challenges when there are constant changes to subscriptions (e.g., quantity updates, price adjustments, term updates) and that it often requires the deployment of multiple billing engines when the company offers a variety of products and services.  Managing a unified invoice with items from various billing engines is not only error-prone, but also makes pricing changes very challenging to manage. 

 

To address these issues, Nue deliberately maintains a separation between orders and subscriptions. Subscriptions are viewed as virtual, recurring customer assets, while orders remain the pivotal monetary transactions used for generating invoices. This intentional separation enhances clarity, minimizes errors, and facilitates smoother adaptation to pricing changes.

Invoice, Invoice Item and Invoice Item Detail

In the Billing Accelerator, invoices assume a pivotal role as the central entities. Generated from orders, they seamlessly integrate into downstream systems such as Collections, Revenue Recognition, and GL systems to facilitate subsequent processes.

 

  • An Invoice represents a customer invoice, encapsulating charges for products or services within specific billable periods.
  • An Invoice Item corresponds to a line or entry in an invoice, outlining the billable quantity and amount of a subscription, asset, or entitlement for a particular billing period of a customer.
  • Invoice Item Detail, a child object of Invoice Item, provides additional granularity by specifying the billable quantity and amount of a specific order product provisioned to the associated subscription, asset, or entitlement linked to the invoice item.

Both Invoices and Invoice Items are used in presenting invoices to customers for payment. The detailed information in Invoice Item Details qualifies them as Invoice Transactions. Due to their references to order products, considered as Order Transactions, they are essential for integration with downstream finance systems, including revenue recognition and GL systems.

Invoice and Order Relationship

It's crucial to highlight that within Nue, there exists a many-to-many relationship between invoices and orders.

An order having more than one invoices

An order, when it contains recurring order products - which will be provisioned into subscriptions, will resut in the generation of one or more invoices, each corresponding to a specific billing period.

 

For instance, consider a customer with an order containing a 12-month recurring order product (a.k.a. subscription) at $100 per month, spanning from 01/01/2024 to 12/31/2024. Given the customer's quarterly billing frequency, the order is typically associated with 4 invoices.

 

In this simple example, each quarterly invoice will have 1 invoice item for the subscription.  Each invoice item will have 1 invoice item detail for the recurring product.  

 

In certain situations, an invoice may combine multiple billing periods. For example, if, for any reason, a Q1 invoice is omitted for the customer, the subsequent Q2 invoice will consolidate all the invoice items from Q1 as well.  So the Q2 invoice will have 2 invoice items for the same subscription, one for each quarterly billing period.  Each invoice item will contain one invoice item detail.  

An invoice associated with one or more orders

An invoice may also be associated with more than one orders.  Consider the following examples: 

 

EXAMPLE #1: A customer places 2 orders.  The first order contains an order product provisioned into a subscription at $100 per month, spanning from 01/01/2024 to 12/31/2024, while the second order contains an one-time order product provisioned into a service entitlement of $500, with the service date on 01/01/2024.  The customer is billed monthly.  So the first invoice with Invoice Date on 01/01/2024 will contain a total billable amount of $600, from both orders. 

 

In this scenario, the first invoice comprises two invoice items. One contains the monthly fee for the subscription, while the other includes the one-time charge associated with the entitlement. Each invoice item is associated with a single invoice item detail, aligning with the billable amount of each respective order product.

 

EXAMPLE #2: A customer places an order that contains a subscription at $100 per month, spanning from 01/01/2024 to 12/31/2024.  A month later, the customer wants to add 10 licenses of the subscription, so they place a second order that contains an additional $50 per month, spanning from 02/01/2024 to 12/31/2024.  The customer is billed monthly.  So the invoice generated on the 2nd month with Invoice Date on 02/01/2024 will contain a total billable amount of $150, from both orders.  

 

In this scenario, the invoice contains a single invoice item, representing the total monthly charge of the subscription.  Within this invoice item, there are two invoice item details, each corresponding to the billable amount of two separate order products - one from each order.

 

NOTE

 

Objects in Billing and Usage Accelerator are originated in Nue, and synchronized to Salesforce.  Objects and fields that do not have a Salesforce API Name do not have a mirrored copy in Salesforce.  

 

The Salesforce API Name is prefixed with namespace `Ruby__`.

Nue Billing Accelerator Objects

Invoice

Represents a customer invoice, encapsulating charges for products or services within specific billable periods. 

 

API NAMEInvoice
SALESFORCE API NAMERuby__Invoice__c

Fields

The following table outlines all fields of the Invoice object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Accounting StatusaccountingStatusAccountingStatus__cIndicates whether or not the invoice was transferred to an external accounting system, such as NetSuite. Available values are: Not Started (Default) Complete Error SkippedText 
Activated ByactivatedById The user who activates the invoiceLookup (UserProfile) 
Activated TimeactivatedTime The time when the invoice gets activatedDate Time 
AmountamountAmount__cThe sum of all invoice items' amount (including product and service charges as well as taxes) in this invoice.Currency 
Amount Without TaxamountWithoutTaxAmountWithoutTax__cThe sum of all invoice items' amount, with tax excluded.Currency 
Applied By IdappliedByIdAppliedByExternalId__cThe id of the invoice or debit memo this negative invoice is refunded for. This field is only available for the negative invoice generated when refunding an invoice or a debit memo.Text 
Applied By ObjectappliedByObject The name of the object this negative invoice is refunded for. This field is only available for the negative invoice generated when refunding an invoice or a debit memo. Available values include: Invoice Debit MemoPickList 
BalancebalanceBalance__cThe remaining balance of the invoice after all payments, adjustments, and refunds are applied.Currency 
Bill To ContactbillToContactIdBillToContactId__cBill To Contact IdLookup (Contact) 
CommentscommentsComment__cThe comments users added when activating or cancelling the invoiceLong Text (32768) 
Created BycreatedByIdPostedById__cThe user who created the recordLookup (UserProfile) 
Created DatecreatedDatePostedTime__cThe date when the record is createdDate Time 
CustomercustomerIdAccountId__cThe billing account idLookup (Customer) 
Due DatedueDateDueDate__cInvoice Due DateDate 
End DateendDateEndDate__cThis date is used to determine the End Date of the billable period, where charges to be billed. All charges that are to be billed on this date or prior will be included in this bill schedule.Date 
External Invoice IdexternalInvoiceIdExternalInvoiceId__cThe id of the invoice record in the payment systemText 
IdidExternalId__cThe id of the recordID 
Invoice DateinvoiceDateInvoiceDate__cInvoice DateDate 
Invoice NumbernameNameThe Invoice Number that will be displayed in an invoice presentable to the end user.Text 
Invoice PdfinvoicePdf The URL of the invoice PDF fileText 
Is Catch UpisCatchUp Indicate whether the invoice is a catch-up invoiceBoolean 
Last Modified BylastModifiedByIdLastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDateLastModifiedDateThe last date when the record is updatedDate Time 
Payment DetailspaymentDetailsPaymentDetails__cThe detailed payment information, for example, payment errors, etc.Text 
Payment Hosted UrlpaymentHostedUrlPaymentHostedUrl__cThe payment hosted URL generated from the payment systemUrl 
Payment StatuspaymentStatusPaymentStatus__cThe invoice status. Available values include: Draft Active CanceledPickList 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__c Currency 
Start DatestartDateStartDate__cThis date is used to determine the Start Date of the billable period, where charges are to be billed.Date 
StatusstatusStatus__cThe invoice status. Available values include: Draft Active CanceledPickList 
Target DatetargetDateTargetDate__cThe target date of the billing schedule which generates the invoiceDate 
Tax AmounttaxAmountTaxAmount__cThe sum of all invoice items' tax amount.Currency 
Tax StatustaxStatusTaxStatus__cThe tax computation status. Available values include: Not Calculated Calculated ErrorText 

Invoice Item

Represents a line item in the invoice that contains the charge of a particular product or service a customer consumed in specific billing period.

 

API NAME(This object only resides in Salesforce)
SALESFORCE API NAMERuby__InvoiceLine__c

Fields

The following table outlines all fields of the Invoice Item object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account IdaccountIdAccountId__cThe billing account idLookup (Customer) 
Applied By Item IdappliedByItemId The id of the invoice item or debit memo item this invoice item is refunded for. This field is only available for the negative invoice generated when refunding an invoice or a debit memo.Text 
Applied By ObjectappliedByObject The name of the object this invoice item is refunded for. This field is only available for the negative invoice generated when refunding an invoice or a debit memo. Available values include: Invoice Item Debit Memo ItemPickList 
Applied CreditsappliedCreditsAppliedCredits__cThe amount of the applied credits in this billing period for the associated usage product that consumes credit.Decimal 
Asset NumberassetNumberAssetNumber__cThe asset numberText 
Asset TypeassetTypeAssetType__cThe asset type. Available values include: Subscription Asset EntitlementPickList 
BalancebalanceBalance__cThe remaining balance of the invoice item after all payments, adjustments, and refunds are applied.Currency 
Billing TimingbillingTimingBillingTiming__cThe billing time of the associated productText 
Created BycreatedByIdCreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDateCreatedDateThe date when the record is createdDate Time 
End DateendDateEndDate__cThe end date of the billable periodDate 
IdidExternalId__cThe id of the recordID 
Invoice Item NumbernameNameThe Invoice Item Number that will be displayed in an invoice presentable to the end user.Text 
Invoice NumberinvoiceNumberInvoiceNumber__cThe Invoice Number of the invoice that contains this invoice itemText 
InvoiceIdinvoiceIdInvoiceExternalId__cThe invoice that contains this invoice itemBMasterDetail 
Is Catch UpisCatchUp Indicate whether the invoice is a catch-up invoiceBoolean 
Last Modified BylastModifiedByIdLastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDateLastModifiedDateThe last date when the record is updatedDate Time 
ProductproductIdProductId__cThe product idID 
Product NameproductNameProductName__cThe product nameText 
Rated CreditsratedCreditsRatedCredits__cThe amount of the rated credits in this billing period for the associated usage product that consumes credit.Decimal 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__c Currency 
Start DatestartDateStartDate__cThe start date of the billable periodDate 
Tax AmounttaxAmountTaxAmount__cThe tax amount.Currency 
Transaction AmounttransactionAmountTransactionAmount__cThe amount being charged for the invoice item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction Amount Without TaxtransactionAmountWithoutTaxTransactionAmountWithoutTax__cThe amount being charged for the invoice item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction DatetransactionDateTransactionDate__cThe Invoice DateDate 
Transaction QuantitytransactionQuantityTransactionQuantity__cThe quantity of the transactionCurrency 
Unit of MeasureuomIdUomId__cThe UOM Id of the product or service.ID 
Unit of Measure Nameuom The UOM of the product or service.  
 
 

Invoice Item Detail

Represents additional granular information of  an invoice item, by specifying the billable quantity and amount of a specific order product provisioned to the associated subscription, asset, or entitlement linked to the invoice item.  The Invoice Item Detail is considered an Invoice Transaction.  

 

API NAMEInvoiceItemDetail
SALESFORCE API NAMERuby__InvoiceItemDetail__c

Fields

The following table outlines all fields of the Invoice Item Detail object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account IDaccountId The Billing Account ID.Lookup (Customer) 
Billed AmountbilledAmountBilledAmount__cThe amount being billed for the associated order product in the current transaction.Currency 
Billing TimingbillingTimingBillingTiming__cThe billing time of the associated order productText 
Created BycreatedByIdCreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDateCreatedDateThe date when the record is createdDate Time 
End DateendDateEndDate__cThe end date of the billable periodDate 
IdidNueId__cThe Id of the record in NueID 
Invoice IdinvoiceId The invoice that the current invoice item detail is associated with.Lookup (Invoice) 
Invoice Item Detail NumbernameNameThe Invoice Item Detail Number.Text 
Invoice Item IdinvoiceItemId The invoice item that the current invoice item detail is associated withBMasterDetail 
Is Catch UpisCatchUp Indicates whether the invoice is a catch-up invoiceBoolean 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Order Product IdorderProductIdOrderProductId__cThe order product that the current invoice item detail is associated withLookup (OrderProduct) 
Sales Account IdsalesAccountId The customer IDLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__cThe costs associated with the transportation and preparation of goods for delivery.Currency 
Start DatestartDateStartDate__cThe start date of the billable periodDate 
Tax AmounttaxAmountTaxAmount__cThe tax amount of the transaction.Currency 
Transaction AmounttransactionAmountTransactionAmount__cThe amount being charged for the associated invoice item. This amount include taxes if the tax engine is enabled.Currency 
Transaction Amount Without TaxtransactionAmountWithoutTaxTransactionAmountWithoutTax__cThe amount being charged for the associated invoice item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction QuantitytransactionQuantityTransactionQuantity__cThe quantity of the transaction.Currency 
TypedetailTypeType__cThe type of the invoice item detail. Available values include: Committed, Overage.PickList 
 

Credit Memo

Represents a customer credit memo that contains the amount reduced for products or services in specific billable periods.

 

API NAMECreditMemo
SALESFORCE API NAMERuby__CreditMemo__c

Fields

The following table outlines all fields of the Credit Memo object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Accounting StatusaccountingStatusAccountingStatus__cIndicates whether or not the credit memo was transferred to an external accounting system, such as NetSuite. Available values are: Not Started (Default) Complete Error SkippedText 
Activated By IdactivatedById The user who activates the credit memoLookup (UserProfile) 
Activated TimeactivatedTime The time when the credit memo gets activatedDate Time 
AmountamountAmount__cThe total amount of the credit memo.Currency 
Amount Without TaxamountWithoutTaxAmountWithoutTax__cThe sum of all invoice items' amount, with tax excludedCurrency 
Applied By IdappliedByIdAppliedByExternalId__cThe id of the invoice or debit memo this credit memo is refunded for. This field is only available for the Credit-Back type credit memo generated when refunding an invoice or a debit memo.Text 
Applied By ObjectappliedByObject The name of the object this credit memo is refunded for. This field is only available for the Credit-Back type credit memo generated when refunding an invoice or a debit memo. Available values include: Invoice Debit MemoPickList 
BalancebalanceBalance__cThe remaining balance of the credit memo that can be applied to invoices or credit memosCurrency 
Bill To ContactbillToContactIdBillToContactId__cThe Bill To Contact JSON structure that holds a snapshot of the Bill To Contact for this credit memo.Lookup (Contact) 
CommentscommentsRuby__Comments__c The comments users added when activating or cancelling the credit memo. Long Text Area(32768) 
Created BycreatedByIdPostedById__cThe user who created the recordLookup (UserProfile) 
Created DatecreatedDatePostedTime__cThe date when the record is createdDate Time 
Credit Memo DatecreditMemoDateCreditMemoDate__cCredit Memo DateDate 
Credit Memo NumbernameNameThe Credit Memo Number that will be displayed in a credit memo presentable to the end user.Text 
CustomercustomerIdAccountId__cThe billing account idLookup (Customer) 
Due DatedueDateDueDate__cCredit Memo Due DateDate 
End DateendDateEndDate__cThis date is used to determine the End Date of the billable period, where charges to be billed. All charges that are to be billed on this date or prior will be included in this bill schedule.Date 
External Credit Memo IdexternalCreditMemoIdExternalCreditMemoId__cThe ID of the credit memo record in the payment systemText 
IdidExternalId__cThe ID of the recordID 
Is Catch UpisCatchUp Indicates whether the credit memo is a catch-up credit memo.Boolean 
Last Modified BylastModifiedByIdLastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDateLastModifiedDateThe last date when the record is updatedDate Time 
Payment DetailspaymentDetailsPaymentDetails__cThe detailed payment information, for example, payment errors, etc.Text 
Payment StatuspaymentStatusPaymentStatus__cThe payment status. Available values include: Not Transferred, Transferred, Paid, Partial Paid, Canceled, Credit-Back Default value is: Not TransferredPickList 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__cThe shipping and handling fee.Currency 
Start DatestartDateStartDate__cThis date is used to determine the Start Date of the billable period, where charges are to be billed.Date 
StatusstatusStatus__cThe Credit Memo status. Available values include: Draft Active CanceledPickList 
Target DatetargetDateTargetDate__cThe target date of the billing schedule which generates the credit memoDate 
Tax AmounttaxAmountTaxAmount__cThe sum of all credit memo items' tax amount.Currency 
Tax StatustaxStatusTaxStatus__cThe tax computation status. Available values include: Not Calculated (Default) Calculated ErrorText 
 

Credit Memo Item

Represents a customer credit memo that contains the amount reduced for products or services in specific billable periods.

 

API NAMECreditMemo
SALESFORCE API NAMERuby__CreditMemo__c

Fields

The following table outlines all fields of the Credit Memo Item object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account IDaccountIdAccountId__cThe customer idLookup (Customer) 
Applied By Item IdappliedByItemId The id of the invoice item or debit memo item this credit memo item is refunded for. This field is only available for the Credit-Back type credit memo generated when refunding an invoice or a debit memo.Text 
Applied By ObjectappliedByObject The name of the object this credit memo item is refunded for. This field is only available for the Credit-Back type credit memo generated when refunding an invoice or a debit memo. Available values include: Invoice Item Debit Memo ItemPickList 
Applied CreditsappliedCreditsAppliedCredits__cThe amount of the applied credits in this billing period for the associated usage product that consumes creditDecimal 
Asset NumberassetNumberAssetNumber__cThe asset numberText 
Asset TypeassetTypeAssetType__cThe asset type. Available values include: Subscription Asset EntitlementPickList 
BalancebalanceBalance__cThe remaining balance of the credit memo item that can be applied to invoice items or credit memo itemsCurrency 
Billing TimingbillingTimingBillingTiming__cThe billing time of the productText 
Created BycreatedById CreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDate CreatedDateThe date when the record is createdDate Time 
Credit Memo Item NumbernameNameThe Credit Memo Item Number that will be displayed in a credit memo presentable to the end user.Text 
Credit Memo NumbercreditMemoNumberCreditMemoNumber__cThe Credit Memo Number of the credit memo that contains this credit memo itemText 
End DateendDateEndDate__cThe end date of the billable periodDate 
IdidExternalId__cThe id of the recordID 
Is Catch UpisCatchUp Indicate whether the credit memo is a catch-up credit memoBoolean 
Last Modified BylastModifiedById LastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate LastModifiedDateThe last date when the record is updatedDate Time 
ProductproductIdProductId__cThe product idID 
Product NameproductNameProductName__cThe product nameText 
Rated CreditsratedCreditsRatedCredits__cThe amount of the rated credits in this billing period for the associated usage product that consumes creditDecimal 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__c Currency 
Start DatestartDateStartDate__cThe start date of the billable periodDate 
Tax AmounttaxAmountTaxAmount__cThe tax amount.Currency 
Transaction AmounttransactionAmountTransactionAmount__cThe amount being charged for the credit memo item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction Amount Without TaxtransactionAmountWithoutTaxTransactionAmountWithoutTax__cThe amount of the credit memo item that doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction DatetransactionDateTransactionDate__cThe Credit Memo DateDate 
Transaction QuantitytransactionQuantityTransactionQuantity__cThe quantity of the transactionCurrency 
Unit of MeasureuomIdUomId__cThe UOM Id of the product or service.ID 
Unit of Measure Nameuom The UOM of the product or service.Text 
creditMemoIdcreditMemoIdCreditMemoExternalId__cThe credit memo that contains this credit memo itemBMasterDetail 

Credit Memo Item Detail

Represents additional granular information of a credit memo item associated to an order product provisioned as the subscription, asset or entitlement related to the credit memo item.  The Credit Memo Item Detail is considered a Credit Memo Transaction.  

 

API NAMECreditMemoItemDetail
SALESFORCE API NAMERuby__CreditMemoItemDetail__c

Fields

The following table outlines all fields of the Credit Memo Item Detail object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account IdaccountId The Billing Account IDLookup (Customer) 
Billed AmountbilledAmountBilledAmount__cThe amount being billed for the associated order product in the current transaction.Currency 
Billing TimingbillingTimingBillingTiming__cThe billing time of the associated order product. Text 
Created BycreatedById CreatedByIdThe user who created the record. Lookup (UserProfile) 
Created DatecreatedDate CreatedDateThe date when the record is created. Date Time 
Credit Memo IdcreditMemoId The credit memo that the current credit memo item detail is associated with.Lookup (CreditMemo) 
Credit Memo Item Detail NumbernameNameThe Credit Memo Item Detail Number.Text 
Credit Memo Item IdcreditMemoItemId The credit memo item that the current credit memo item detail is associated withBMasterDetail 
End DateendDateEndDate__cThe end date of the billable period. Date 
IdidNueId__cThe id of the recordID 
Is Catch UpisCatchUp Indicates whether the invoice is a catch-up invoiceBoolean 
Last Modified BylastModifiedByIdLastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDateLastModifiedDate The last date when the record is updatedDate Time 
Order Product IdorderProductIdOrderProductId__cThe order product that the current credit memo item detail is associated withLookup (OrderProduct) 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Shipping And HandlingshippingAndHandlingShippingAndHandling__cThe costs associated with the transportation and preparation of goods for delivery.Currency 
Start DatestartDateStartDate__cThe start date of the billable periodDate 
Tax AmounttaxAmountTaxAmount__cThe tax amount of the transaction.Currency 
Transaction AmounttransactionAmountTransactionAmount__cThe amount being charged for the associated credit memo item. This amount include taxes if the tax engine is enabled.Currency 
Transaction Amount Without TaxtransactionAmountWithoutTaxTransactionAmountWithoutTax__cThe amount being charged for the associated credit memo item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction QuantitytransactionQuantityTransactionQuantity__cThe quantity of the transaction.Currency 
TypedetailTypeType__cThe type of the invoice item detail. Available values include: Committed, Overage.PickList 
 

Debit Memo

Represents a document that indicates a reduction in the amount owed by one party to another party.

 

API NAMEDebitMemo
SALESFORCE API NAMERuby__DebitMemo__c

Fields

The following table outlines all fields of the Debit Memo object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Activated ByactivatedById The user who activates the debit memoLookup (UserProfile) 
Activated TimeactivatedTime The time when the invoice gets activatedDate Time 
Amountamount Ruby__Amount__c The total amount of the debit memo.Currency 
Amount Without TaxamountWithoutTax Ruby__AmountWithoutTax__cThe sum of all debit memo items' amount, with tax excludedCurrency 
Balancebalance Ruby__Balance__cThe remaining balance of the debit memo after all payments, adjustments, and refunds are applied.Currency 
Charge ReasonchargeReason Ruby__ChargeReason__cCharge reason of the debit memo, available values include: Late Fee Additional Fee Billing DiscrepanciesPickList 
Created BycreatedById CreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate CreatedDateThe date when the record is createdDate Time 
CustomercustomerId Ruby__AccountId__cThe billing account idLookup (Customer) 
Debit Memo NumbernameName The Debit Memo Number that will be displayed in a debit memo presentable to the end user.Text 
Descriptiondescription Ruby__Description__cAdditioanl description of the debit memoText 
End DateendDate Ruby__EndDate__c This date is used to determine the End Date of the billable period, where charges to be billed. All charges that are to be billed on this date or prior will be included in this bill schedule.Date 
Idid The id of the recordID 
Last Modified BylastModifiedById LastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate LastModifiedDateThe last date when the record is updatedDate Time 
Payment StatuspaymentStatus Ruby__PaymentStatus__cThe payment status. Available values include: Not Transferred, Transferred, Paid, Partial Paid, Canceled, Refunded, Partial Refunded Default value is: Not TransferredPickList 
Source IdsourceId The ID of the invoice that generates the debit memoText 
Source TypesourceType The name of the object that generates the debit memo. Available values include: InvoicePickList 
Start DatestartDate Ruby__StartDate__c This date is used to determine the Start Date of the billable period, where charges are to be billed.Date 
Statusstatus Ruby__Status__cThe Debit Memo status. Available values include: Draft Active CanceledPickList 
Tax AmounttaxAmount Ruby__TaxAmount__cThe sum of all debit memo items' tax amount.Currency 
Tax StatustaxStatus Ruby__TaxStatus__cThe tax computation status. Available values include: Not Calculated (Default) Calculated ErrorText 

Debit Memo Item

Represents a record of a debit amount issued by a seller to a buyer, usually to correct an error or discrepancy in a previous transaction.

 

API NAMEDebitMemoItem
SALESFORCE API NAMERuby__DebitMemoItem__c

Fields

The following table outlines all fields of the Debit Memo Item object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account IdaccountId Ruby__AccountId__cThe billing account idLookup (Customer) 
Balancebalance Ruby__Balance__cThe remaining balance of the debit memo item after all payments, adjustments, and refunds are applied.Currency 
Created BycreatedById CreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate CreatedByDateThe date when the record is createdDate Time 
Debit Memo IddebitMemoId Ruby__DebitMemoId__cThe debit memo IdBMasterDetail 
Debit Memo Item Numbername NameThe Debit Memo Item Number that will be displayed in a debit memo presentable to the end user.Text 
End DateendDate Ruby__EndDate__c The end date of the billable periodDate 
Idid ID The id of the recordID 
Last Modified BylastModifiedById LastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate LastModifiedDate The last date when the record is updatedDate Time 
Source IdsourceId The id of the invoice item that generates the debit memo itemText 
Source TypesourceType The name of the object that generates the debit memo. Available values include: InvoiceItemPickList 
Start DatestartDate The start date of the billable periodDate 
Tax AmounttaxAmount Ruby__TaxAmount__cThe tax amount.Currency 
Transaction AmounttransactionAmount Ruby__TransactionAmount__cThe amount being charged for the debit memo item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 
Transaction Amount Without TaxtransactionAmountWithoutTax Ruby__TransactionAmountWithoutTax__cThe amount being charged for the debit memo item. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.Currency 

Payment Application

Represents how and when a payment transaction occurs to an invoice.

 

API NAMEPaymentApplication
SALESFORCE API NAMERuby__PaymentApplication__c

Fields

The following table outlines all fields of the Payment Application object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Applied AmounttransactionAmountTransactionAmount__cThe payment amount appliedCurrency 
Applied DatetransactionDateTransactionDate__cThe date when the payment appliedDate 
Created BycreatedByIdCreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDateCreatedDate The date when the record is createdDate Time 
Credit Memo IDcreditMemoIdCreditMemoId__cThe ID of the credit memo applied to the invoice or unapplied to the invoiceID 
IdidExternalId__cThe id of the recordID 
InvoiceinvoiceIdInvoiceId__cThe ID of the invoice that the payment is applied to.Lookup (Invoice) 
Last Modified BylastModifiedByIdLastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate LastModifiedDateThe last date when the record is updatedDate Time 
Negative Invoice IDnegativeInvoiceIdNegativeInvoiceId__c The ID of the applied negative invoice applied to the invoice or unapplied to the invoiceID 
Payment Application NumbernameNameThe payment application number.Text 
Payment IDpaymentIdPaymentId__cThe ID of the payment record in the source system.Id 
Payment MethodpaymentMethodPaymentMethod__cThe method of how the payment is processed. Available values include: Electronic, Non-electronicPickList 
Payment NumberpaymentNumberPaymentNumber__cThe payment number of the payment record in the source system, e.g., PAY-001Text 
Payment SourcepaymentSourcePaymentSource__cThe name of the payment system. Available values include: Stripe, Quickbooks, NetSuite, Nue, etc.PickList 
Payment TypepaymentTypePaymentType__cThe name of the object which processes a payment. Available values include: Payment, NegativeInvoice, CreditMemo, CreditPickList 
Record typerecordTypeRecordType__cThe type of the payment application. Available values include: Payment, Refund.PickList 
StatusstatusStatus__cThe status of the payment application. Available values include: Active, Canceled.PickList 
TimestamptimestampTimestamp__cThe timestamp when the payment appliedDate Time 

Payment Application Item

Represents a payment transaction occurred to an invoice at the line level.

 

API NAMEPaymentApplicationItem
SALESFORCE API NAMERuby__PaymentApplicationItem__c

Fields

The following table outlines all fields of the Payment Application Item object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Applied AmounttransactionAmountTransactionAmount__cThe payment amount applied by this itemCurrency 
Applied DatetransactionDateTransactionDate__cThe date when the payment appliedDate 
Created BycreatedByIdCreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDateCreatedDate The date when the record is createdDate Time 
Credit Memo Item IDcreditMemoItemId CreditMemoItemId__cThe ID of credit memo item applied to the invoice or unapplied to the invoiceID 
Idid The id of the recordID 
Invoice Item IDinvoiceItemIdInvoiceItemId__cThe invoice item that this payment is applied toID 
Last Modified BylastModifiedByIdLastModifiedByIDThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDateLastModifiedDate The last date when the record is updatedDate Time 
Negative Invoice Item IDnegativeInvoiceItemIdNegativeInvoiceItemId__c The ID of negative invoice item applied to the invoice or unapplied to the invoice, and also for offseting the balance of positive invoice item by the negative invoice item in the same invoiceID 
Payment Application IDpaymentApplicationIdPaymentApplicationId__cThe id of the payment applicationID 
Payment Application Item NumbernameNameThe payment application item number.Text 
Payment MethodpaymentMethodPaymentMethod__cThe method of how the payment is processed. Available values include: Electronic, Non-electronicPickList 
Payment TypepaymentTypePayment_Type__cThe name of the object which processes a payment. Available values include: Payment, NegativeInvoice, CreditMemo, CreditPickList 
Record typerecordTypeRecordTypeIdThe type of the payment application. Available values include: Payment, Refund.PickList 
TimestamptimestampTimestamp__cThe timestamp when the payment appliedDate Time 

Billing Schedule

Represents a structured framework for organizing and managing the timing and execution of billing processes. 

 

API NAMEBillingSchedule
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Billing Schedule object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Auto ActivateautoActivate Indicate whether auto-activate the generated invoicesBoolean 
Bill Cycle Day FilterbillCycleDayFilter The filtered biiling cycle day, for example, 1st of MonthText 
Catch-up ModecatchUpMode Indicate the mode when running a catch up billing schedule. Available values include: GenerateInvoices SimulationPickList 
Clean Catch-upcleanCatchUp Indicate whether the previous generated catch-up type invoices or credit memos need to be deleted when runing a new catch up billing scheduleBoolean 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Created ThroughcreatedThrough Indicate how the billing schedule gets created. Available values include: Web Application APIPickList 
Customer FiltercustomerFilter The graphQL conditions of the customer filtersText 
Customer Filter for UIcustomerFilterForUi The JSON formatted graphQL conditions of the customer filtersText 
Idid The id of the recordID 
Include Billing AccountsincludeBillingAccounts Indicate whether the associated billing accounts need to be billed together with their sales accounts in this billing scheduleBoolean 
Include SubsidiariesincludeSubsidiaries Indicate whether the associated child accounts need to be billed together with their parent accounts in this billing scheduleBoolean 
Invoice DateinvoiceDate The invoice date displayed on the invoicesDate 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Last Run DatelastRunDate The last billing run date of this billing scheduleDate 
Order FilterorderFilter The graphQL conditions of the order filtersText 
Order Filter for UIorderFilterForUi The JSON formatted graphQL conditions of the order filtersText 
Product FilterproductFilter The graphQL conditions of the product filtersText 
Product Filter for UIproductFilterForUi The JSON formatted graphQL conditions of the product filtersText 
Recurring JSONrecurringJson The JSON formattted Regular Expression capturing the billing job recurring scheduleText 
Recurring SchedulerecurringSchedule A Regular Expression capturing the billing job recurring scheduleText 
Schedule Numbername The billing schedule number.Text 
Schedule Start DatescheduleStartDate The date that the first billing job is executed.Date 
Schedule TypescheduleType The type of the Billing Schedule. Available values include: Recurring On DemandPickList 
Split Invoice By PeriodsplitByPeriod Indicate whether to generate invoices and credit memos for each billing periodsBoolean 
Statusstatus The billing schedule status. Available values include: Draft Active Canceled CompletedPickList 
Target DatetargetDate The date used to determine which order products to be billed. All order products that are to be billed on this date or prior to this date will be included in the billing job.Date 
TimezonezoneId The billing schedule running timezoneText 

Billing Job

Represents an execution instance of a billing schedule.  A one-time billing schedule has one billing job, and a recurring billing schedule has one or more billing jobs.  

 

API NAMEBillingJob
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Billing Job object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Billing Schedule IdbillingScheduleId The id of the Billing Schedule which triggers the jobLookup (BillingSchedule) 
Catch-up ModecatchUpMode Indicate the mode when running a catch up billing schedule. Available values include: GenerateInvoices SimulationPickList 
Clean Catch-upcleanCatchUp Indicate whether the previous generated catch-up type invoices or credit memos need to be deleted when runing a new catch up billing scheduleBoolean 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Credit Memos GeneratedcreditMemosGenerated Total credit memos generated in this billing job.Integer 
Customer InvoicedcustomerInvoiced Total customers invoiced in this billing jobInteger 
End TimeendTime The time when the billing job ends.Date Time 
Error MessageerrorMessage The detailed error message if the current billing job has errorsText 
Execution TimeexecutionTime The time in milliseconds between the start date and end dateInteger 
Idid The id of the recordID 
Invoice DateinvoiceDate Invoice Date of this billing jobDate 
Invoices GeneratedinvoicesGenerated Total invoice generated in this billing job.Integer 
Job Numbername The billing job number.Text 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Relationsrelations Information of invoiced customers and their generated invoices and credit memosText 
Split By PeriodsplitByPeriod Indicate whether to generate invoices and credit memos for each billing periodsBoolean 
Start TimestartTime The time when the billing job starts.Date Time 
Statusstatus The status of the billing job. Available values include: Scheduled Processing Completed Error Canceled ActivatedText 
Target DatetargetDate Target Date of this billing jobDate 

Billing State

Tracks the invoicing statuses of the associated order product. 

 

API NAMEBillingState
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Billing State object.  
FIELD NAMEAPI NAMEDESCRIPTIONTYPE 
Asset IdassetIdThe ID of the associated asset.ID 
Asset NumberassetNumberThe asset number, such as Subscription Number, Asset Number, Entitlement Number, etc.Text(255) 
Asset TypeassetTypeThe type of the associated asset, including Subscription, Asset, Entitlement, etc.PickList 
Billed AmountbilledAmountThe cumulative amount invoiced for the associated order product.Currency 
Billed QuantitybilledQuantityThe cumulative quantity invoiced for this order product.Decimal 
Billed Shipping and HandlingbilledShippingThe cumulative shipping and handling invoiced for this order product.Currency 
Billing AccountbillingAccountIdThe ID of the billing account for the associated order product.Lookup (Customer) 
Created BycreatedByIdThe user who created this record.Lookup (UserProfile) 
Created DatecreatedDateThe date when the record is created.Date Time 
IDidThe record ID.ID 
Invoiced UntilinvoicedUntilThe date up to which billing has been processed for the order product.Date 
Last Modified BylastModifiedByIdThe user who last updated the record.Lookup (UserProfile) 
Last Modified DatelastModifiedDateThe date when the record is last updated.Date Time 
Next Billing DatenextBillingDateThe date for the next billing cycle of the order product.Date 
Order ProductorderProductIdThe associated order product.MasterDetail (OrderProduct) 
Order Product NumbernameThe Order Product NumberText(80) 
Product IdproductIdThe product IDText(80) 
Product NameproductNameThe product NameText(255) 
Product SKUproductSKUThe product SKUText(80) 
Sales AccountsalesAccountIdThe ID of the sales account for the associated order product.Lookup (Customer) 

Nue Usage Accelerator Objects

Raw Usage

Represents a raw usage record resulted from a measuable consumption of a product or service.

 

API NAMERawUsage
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Raw Usage object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Created DatecreatedDate The date when the record is createdDate Time 
Customer IdcustomerId The billing account IdID 
Idid The id of the recordID 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Propertiesproperties A JSON representation of the custom properties of the raw usageText 
Quantityquantity The quantity of the raw usageDecimal 
Raw Usage Numbername The raw usage number.AutoNumber 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Subscription IdsubscriptionId The id of the subscription this raw usage is forID 
Timestamptimestamp The timestamp of when the raw usage occursDate Time 
Transaction IdtransactionId Indicate the group of raw usage dataText 
Usage IdusageId The id of the generate usage after this raw usage gets ratedLookup (Usage) 

Usage

Represents a rated usage record resulted from grouping of a set of usage records.

 

API NAMEUsage
SALESFORCE API NAMERuby__NueUsage__c

Fields

The following table outlines all fields of the Usage object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Created DatecreatedDate CreatedDateThe date when the record is createdDate Time 
Credits AppliedcreditsApplied Ruby__CreditsApplied__cThe amount of applied credits for this usageDecimal 
Customer IdcustomerId Ruby__Account__cThe billing account IdLookup (Customer) 
End TimeendTime Ruby__EndTime__c The end time of the raw usage window.Date Time 
Error CodeerrorCode Ruby__ErrorCode__cThe error code when rating the usage if it hasText 
Error MessageerrorMessage Ruby__ErrorMessage__cThe error message when rating the usage if it hasText 
Idid  The id of the recordID 
Invoice IdinvoiceId Ruby__Invoice__cThe associated invoice idID 
Invoice Item IdinvoiceItemId Ruby__InvoiceItem__cThe associated invoice item idID 
Invoice Item NumberinvoiceItemNumber Ruby__InvoiceItemNumber__cThe associated invoice item numberText 
Invoice NumberinvoiceNumber Ruby__InvoiceNumber__cThe associated invoice numberText 
Is CashisCash Ruby__IsCash__cIndicates whether the rated amount is cash typeBoolean 
Last Modified DatelastModifiedDate LastModifiedDateThe last date when the record is updatedDate Time 
Order NumberorderNumber Ruby__OrderNumber__cThe number of the associated order of this usageText 
Order Product IdorderProductId Ruby__OrderProduct__cThe order product associated with the subscription.ID 
Order Product NumberorderProductNumber Ruby__OrderProductNumber__cThe number of the associated order product of this usageText 
Product IdproductId Ruby__Product__cThe usage product IDLookup (Product) 
Propertiesproperties Ruby__Properties__cA JSON representation of the custom properties of the raw usageText 
Quantityquantity Ruby__Quantity__cThe consumed quantity of this usage.Decimal 
Ratable TimeratableTime The time offset when processing rating serviceDate Time 
Rated AmountratedAmount Ruby__RatedAmount__cThe rated amount of the usage, returned by the rating engine.Decimal 
Rated TimeratedTime Ruby__RatedTime__cThe rated time of the usage recordDate Time 
Sales Account IdsalesAccountId Ruby__SalesAccountId__cThe customer idLookup (Customer) 
Start TimestartTime Ruby__StartTime__cThe start time of the raw usage window.Date Time 
Statusstatus Ruby__Status__cThe usage status. Available values include: Open Rated Billed ErrorPickList 
Subscription IdsubscriptionId Ruby__Subscription__cThe subscription ID, which is always the latest version of the subscription.ID 
Subscription NumbersubscriptionNumber Ruby__SubscriptionNumber__cThe subscription number.Text 
Term End DatetermEndDate Ruby__TermEndDate__cThe End Date of the usage term, used by the rating engine.Date 
Term Start DatetermStartDate Ruby__TermStartDate__cThe Start Date of the usage term, used by the rating engine.Date 
Termed Total QuantitytermedTotalQuantity Ruby__TermedTotalQuantity__cThe total quantity already consumed in the usage term, including the quantity of the current usage, used by the rating engine.Decimal 
Usage Numbername NameThe usage number.AutoNumber 
Window SizewindowSize Ruby__WindowSize__cThe window size of the raw usage. Available values include: DAY HOURPickList 
Zone IdzoneId Ruby__TimeZone__cThe timezone informationText 

Credit Pool

Defines the system credit pool, which will be used as a template to generate Account Credit Pool for each customer.

 

API NAMECreditPool
SALESFORCE API NAMERuby__CreditPool__c

Fields

The following table outlines all fields of the Credit Pool object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Created BycreatedById CreatedByIdThe user who created the recordLookup (UserProfile) 
Created DatecreatedDate CreatedDateThe date when the record is createdDate Time 
Credit Pool Namename NameThe name of the credit poolText 
Credit Type IdcreditTypeId Ruby__CreditType__cThe id of the credit typeLookup (CreditType) 
Idid IdThe id of the recordID 
Is DefaultisDefault Ruby__IsDefault__cDetermines if the current credit pool is used as system default credit poolBoolean 
Last Modified BylastModifiedById LastModifiedByIdThe last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate LastModifiedDateThe last date when the record is updatedDate Time 

Account Credit Pool

Represents the credit pool for each customer, which contains the credits issued to the customer and the flows of how the credit balance changes.

 

API NAMEAccountCreditPool
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Account Credit Pool object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account Credit Pool Numbername The number of the account credit poolText 
Balancebalance The balance of the account credit poolDecimal 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Credit Pool IdcreditPoolId The id of the credit poolLookup (CreditPool) 
Credit Type IdcreditTypeId The id of the credit typeLookup (CreditType) 
Customer IdcustomerId The Customer ID that the credit pool belongs toLookup (Customer) 
Idid The id of the recordID 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Statusstatus The status of the account credit pool, available options: ActivePickList 

Credit Type

Represents the type of credit, which can be Credit or Cash.

 

API NAMECreditType
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Credit Type object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Credit Typecategory The category of the credit type, Available values include: Credit CashPickList 
Credit Type Namename The display name of the credit typeText 
Idid The id of the recordID 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Statusstatus Indicates whether the credit type is active, available options: Active, InactivePickList 

 

Credit

Represents the credit issued by a Credit Burn-down product or service the customer purchased. 

 

API NAMECredit
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Credit object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account Pool IdaccountPoolId The Account Pool ID that the credit belongs toID 
Amountamount The total amount of the creditDecimal 
Asset IdassetId The id of the associated assetID 
Asset NumberassetNumber The number of the associated assetText 
Asset TypeassetType The type of the associated assetPickList 
Balancebalance The balance of the creditDecimal 
Cash AmountcashAmount The cash amout of the creditCurrency 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Credit Numbername The number of the creditText 
Credit Type IdcreditTypeId The id of the credit typeLookup (CreditType) 
Customer IdcustomerId The Customer ID that the credit belongs toLookup (Customer) 
End DateendDate The expiration date of the creditDate 
End TimeendTime The expiration datetime of the creditDate Time 
Idid The id of the recordID 
Issue DateissueDate The date when the credit is issuedDate 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Order Product IdorderProductId The id of the associated order productLookup (OrderProduct) 
Start DatestartDate The start date of the creditDate 
Start TimestartTime The start datetime of the creditDate Time 
Time ZonetimeZone The time zome information when the credit is issuedText 

Credit Flow

Represents the credit inflow (grants) and outflow (consumption) of a certain amount of credits.

 

API NAMECreditFlow
SALESFORCE API NAME(This object does not have a mirrored copy in Salesforce)

Fields

The following table outlines all fields of the Credit Flow object.  
FIELD NAMEAPI NAMESALESFORCE API NAMEDESCRIPTIONTYPE 
Account Pool IdaccountPoolId The Account Pool ID that the credit flow belongs toID 
Balancebalance The balance of the creditDecimal 
Created BycreatedById The user who created the recordLookup (UserProfile) 
Created DatecreatedDate The date when the record is createdDate Time 
Credit End DatecreditEndDate The expiration date of the creditDate 
Credit Flow Numbername The number of the creidt flowText 
Credit IdcreditId The id of the associated creditID 
Credit NumbercreditNumber The number of the associated creditText 
Credit Start DatecreditStartDate The start date of the creditDate 
Credit Type IdcreditTypeId The id of the credit typeLookup (CreditType) 
Customer IdcustomerId The Customer ID that the credit flow belongs toLookup (Customer) 
Idid The id of the recordID 
Last Modified BylastModifiedById The last user who updated the recordLookup (UserProfile) 
Last Modified DatelastModifiedDate The last date when the record is updatedDate Time 
Record TyperecordType The record type of the credit flow, available options : Inflow / OutflowPickList 
Sales Account IdsalesAccountId The customer idLookup (Customer) 
Subscription NumberassetNumber The number of the associated assetText 
Transaction AmounttransactionAmount The transaction amount included in the credit flowDecimal 
Transaction DatetransactionDate The date when the transaction occursDate 
Transaction SourcetransactionSource The source object to consume the credit, available options : Usage / Payment Application ItemText 
Transaction Source IdtransactionSourceId The source object id associated with the credit flowText 
Transaction TypetransactionType The transaction type of the credit flow, available options : Issue / Consume / Cancel / ExpirePickList