Nue Object Model - Billing & Usage Accelerator

nue billing accelerator overview docid\ rb 2ga 7mzxybhrbb4rfo and usage accelerator overview docid\ pqjb7g6ruwbgb9hs5tzrb 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 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 docid 64c6d58b9265016d34247835576e37adc954bc10 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 docid 64c6d58b9265016d34247835576e37adc954bc10 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 docid 64c6d58b9265016d34247835576e37adc954bc10 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 resutin 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 ` docid 64c6d58b9265016d34247835576e37adc954bc10 nue billing accelerator objects docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 invoice represents a customer invoice, encapsulating charges for products or services within specific billable periods api name invoice salesforce api name ruby invoice c fields the following table outlines all fields of the invoice object field name api name salesforce api name description type accounting status accountingstatus accountingstatus c indicates whether or not the invoice was transferred to an external accounting system, such as netsuite available values are not started (default) complete error skipped text activated by activatedbyid the user who activates the invoice lookup (userprofile) activated time activatedtime the time when the invoice gets activated date time amount amount amount c the sum of all invoice items' amount (including product and service charges as well as taxes) in this invoice currency amount without tax amountwithouttax amountwithouttax c the sum of all invoice items' amount, with tax excluded currency applied by id appliedbyid appliedbyexternalid c the 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 object appliedbyobject 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 memo picklist balance balance balance c the remaining balance of the invoice after all payments, adjustments, and refunds are applied currency bill to contact billtocontactid billtocontactid c bill to contact id lookup ( contact docid 64c6d58b9265016d34247835576e37adc954bc10 ) comments comments comment c the comments users added when activating or cancelling the invoice long text (32768) created by createdbyid postedbyid c the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate postedtime c the date when the record is created date time customer customerid accountid c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) cancellation date cancellationdate ruby cancelationdate c the date when the invoice is canceled date due date duedate duedate c invoice due date date end date enddate 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 external invoice id externalinvoiceid externalinvoiceid c the id of the invoice record in the payment system text id id externalid c the id of the record id invoice date invoicedate invoicedate c invoice date date invoice number name name the invoice number that will be displayed in an invoice presentable to the end user text invoice pdf invoicepdf the url of the invoice pdf file text is catch up iscatchup indicate whether the invoice is a catch up invoice boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time payment details paymentdetails paymentdetails c the detailed payment information, for example, payment errors, etc text payment hosted url paymenthostedurl paymenthostedurl c the payment hosted url generated from the payment system url payment status paymentstatus paymentstatus c the invoice status available values include draft active canceled picklist sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c currency start date startdate startdate c this date is used to determine the start date of the billable period, where charges are to be billed date status status status c the invoice status available values include draft active canceled picklist target date targetdate targetdate c the target date of the billing schedule which generates the invoice date tax amount taxamount taxamount c the sum of all invoice items' tax amount currency tax status taxstatus taxstatus c the tax computation status available values include not calculated calculated error text docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 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 name ruby invoiceline c fields the following table outlines all fields of the invoice item object field name api name salesforce api name description type account id accountid accountid c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) applied by item id appliedbyitemid 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 object appliedbyobject 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 item picklist applied credits appliedcredits appliedcredits c the amount of the applied credits in this billing period for the associated usage product that consumes credit decimal asset number assetnumber assetnumber c the asset number text asset type assettype assettype c the asset type available values include subscription asset entitlement picklist balance balance balance c the remaining balance of the invoice item after all payments, adjustments, and refunds are applied currency billing timing billingtiming billingtiming c the billing time of the associated product text created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time end date enddate enddate c the end date of the billable period date id id externalid c the id of the record id invoice item number name name the invoice item number that will be displayed in an invoice presentable to the end user text invoice number invoicenumber invoicenumber c the invoice number of the invoice that contains this invoice item text invoiceid invoiceid invoiceexternalid c the invoice that contains this invoice item bmasterdetail is catch up iscatchup indicate whether the invoice is a catch up invoice boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time product productid productid c the product id id product name productname productname c the product name text rated credits ratedcredits ratedcredits c the amount of the rated credits in this billing period for the associated usage product that consumes credit decimal sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c currency start date startdate startdate c the start date of the billable period date tax amount taxamount taxamount c the tax amount currency transaction amount transactionamount transactionamount c the 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 tax transactionamountwithouttax transactionamountwithouttax c the 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 date transactiondate transactiondate c the invoice date date transaction quantity transactionquantity transactionquantity c the quantity of the transaction currency unit of measure uomid uomid c the uom id of the product or service id unit of measure name uom the uom of the product or service docid 64c6d58b9265016d34247835576e37adc954bc10 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 name invoiceitemdetail salesforce api name ruby invoiceitemdetail c fields the following table outlines all fields of the invoice item detail object field name api name salesforce api name description type account id accountid the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) billed amount billedamount billedamount c the amount being billed for the associated order product in the current transaction currency billing timing billingtiming billingtiming c the billing time of the associated order product text created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time end date enddate enddate c the end date of the billable period date id id nueid c the id of the record in nue id invoice id invoiceid the invoice that the current invoice item detail is associated with lookup ( invoice docid 64c6d58b9265016d34247835576e37adc954bc10 ) invoice item detail number name name the invoice item detail number text invoice item id invoiceitemid the invoice item that the current invoice item detail is associated with bmasterdetail is catch up iscatchup indicates whether the invoice is a catch up invoice boolean last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time order product id orderproductid orderproductid c the order product that the current invoice item detail is associated with lookup ( orderproduct docid 64c6d58b9265016d34247835576e37adc954bc10 ) sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c the costs associated with the transportation and preparation of goods for delivery currency start date startdate startdate c the start date of the billable period date tax amount taxamount taxamount c the tax amount of the transaction currency transaction amount transactionamount transactionamount c the amount being charged for the associated invoice item this amount include taxes if the tax engine is enabled currency transaction amount without tax transactionamountwithouttax transactionamountwithouttax c the 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 quantity transactionquantity transactionquantity c the quantity of the transaction currency type detailtype type c the type of the invoice item detail available values include committed, overage picklist docid 64c6d58b9265016d34247835576e37adc954bc10 credit memo represents a customer credit memo that contains the amount reduced for products or services in specific billable periods api name creditmemo salesforce api name ruby creditmemo c fields the following table outlines all fields of the credit memo object field name api name salesforce api name description type accounting status accountingstatus accountingstatus c indicates whether or not the credit memo was transferred to an external accounting system, such as netsuite available values are not started (default) complete error skipped text activated by id activatedbyid the user who activates the credit memo lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) activated time activatedtime the time when the credit memo gets activated date time amount amount amount c the total amount of the credit memo currency amount without tax amountwithouttax amountwithouttax c the sum of all invoice items' amount, with tax excluded currency applied by id appliedbyid appliedbyexternalid c the 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 object appliedbyobject 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 memo picklist balance balance balance c the remaining balance of the credit memo that can be applied to invoices or credit memos currency bill to contact billtocontactid billtocontactid c the bill to contact json structure that holds a snapshot of the bill to contact for this credit memo lookup ( contact docid 64c6d58b9265016d34247835576e37adc954bc10 ) comments comments ruby comments c the comments users added when activating or cancelling the credit memo long text area(32768) cancellation date cancellationdate ruby cancelationdate c the date when the credit memo is canceled date due date duedate duedate c invoice due date date created date createddate postedtime c the date when the record is created date time credit memo date creditmemodate creditmemodate c credit memo date date credit memo number name name the credit memo number that will be displayed in a credit memo presentable to the end user text customer customerid accountid c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) due date duedate duedate c credit memo due date date end date enddate 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 external credit memo id externalcreditmemoid externalcreditmemoid c the id of the credit memo record in the payment system text id id externalid c the id of the record id is catch up iscatchup indicates whether the credit memo is a catch up credit memo boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time payment details paymentdetails paymentdetails c the detailed payment information, for example, payment errors, etc text payment status paymentstatus paymentstatus c the payment status available values include not transferred, transferred, paid, partial paid, canceled, credit back default value is not transferred picklist sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c the shipping and handling fee currency start date startdate startdate c this date is used to determine the start date of the billable period, where charges are to be billed date status status status c the credit memo status available values include draft active canceled picklist target date targetdate targetdate c the target date of the billing schedule which generates the credit memo date tax amount taxamount taxamount c the sum of all credit memo items' tax amount currency tax status taxstatus taxstatus c the tax computation status available values include not calculated (default) calculated error text docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 credit memo item represents a customer credit memo that contains the amount reduced for products or services in specific billable periods api name creditmemo salesforce api name ruby creditmemo c fields the following table outlines all fields of the credit memo item object field name api name salesforce api name description type account id accountid accountid c the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) applied by item id appliedbyitemid 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 object appliedbyobject 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 item picklist applied credits appliedcredits appliedcredits c the amount of the applied credits in this billing period for the associated usage product that consumes credit decimal asset number assetnumber assetnumber c the asset number text asset type assettype assettype c the asset type available values include subscription asset entitlement picklist balance balance balance c the remaining balance of the credit memo item that can be applied to invoice items or credit memo items currency billing timing billingtiming billingtiming c the billing time of the product text created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time credit memo item number name name the credit memo item number that will be displayed in a credit memo presentable to the end user text credit memo number creditmemonumber creditmemonumber c the credit memo number of the credit memo that contains this credit memo item text end date enddate enddate c the end date of the billable period date id id externalid c the id of the record id is catch up iscatchup indicate whether the credit memo is a catch up credit memo boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time product productid productid c the product id id product name productname productname c the product name text rated credits ratedcredits ratedcredits c the amount of the rated credits in this billing period for the associated usage product that consumes credit decimal sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c currency start date startdate startdate c the start date of the billable period date tax amount taxamount taxamount c the tax amount currency transaction amount transactionamount transactionamount c the 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 tax transactionamountwithouttax transactionamountwithouttax c the amount of the credit memo item that doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive currency transaction date transactiondate transactiondate c the credit memo date date transaction quantity transactionquantity transactionquantity c the quantity of the transaction currency unit of measure uomid uomid c the uom id of the product or service id unit of measure name uom the uom of the product or service text creditmemoid creditmemoid creditmemoexternalid c the credit memo that contains this credit memo item bmasterdetail docid 64c6d58b9265016d34247835576e37adc954bc10 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 name creditmemoitemdetail salesforce api name ruby creditmemoitemdetail c fields the following table outlines all fields of the credit memo item detail object field name api name salesforce api name description type account id accountid the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) billed amount billedamount billedamount c the amount being billed for the associated order product in the current transaction currency billing timing billingtiming billingtiming c the billing time of the associated order product text created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time credit memo id creditmemoid the credit memo that the current credit memo item detail is associated with lookup ( creditmemo docid 64c6d58b9265016d34247835576e37adc954bc10 ) credit memo item detail number name name the credit memo item detail number text credit memo item id creditmemoitemid the credit memo item that the current credit memo item detail is associated with bmasterdetail end date enddate enddate c the end date of the billable period date id id nueid c the id of the record id is catch up iscatchup indicates whether the invoice is a catch up invoice boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time order product id orderproductid orderproductid c the order product that the current credit memo item detail is associated with lookup ( orderproduct docid 64c6d58b9265016d34247835576e37adc954bc10 ) sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) shipping and handling shippingandhandling shippingandhandling c the costs associated with the transportation and preparation of goods for delivery currency start date startdate startdate c the start date of the billable period date tax amount taxamount taxamount c the tax amount of the transaction currency transaction amount transactionamount transactionamount c the amount being charged for the associated credit memo item this amount include taxes if the tax engine is enabled currency transaction amount without tax transactionamountwithouttax transactionamountwithouttax c the 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 quantity transactionquantity transactionquantity c the quantity of the transaction currency type detailtype type c the type of the invoice item detail available values include committed, overage picklist docid 64c6d58b9265016d34247835576e37adc954bc10 debit memo represents a document that indicates a reduction in the amount owed by one party to another party api name debitmemo salesforce api name ruby debitmemo c fields the following table outlines all fields of the debit memo object field name api name salesforce api name description type activated by activatedbyid the user who activates the debit memo lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) activated time activatedtime the time when the invoice gets activated date time amount amount ruby amount c the total amount of the debit memo currency amount without tax amountwithouttax ruby amountwithouttax c the sum of all debit memo items' amount, with tax excluded currency balance balance ruby balance c the remaining balance of the debit memo after all payments, adjustments, and refunds are applied currency charge reason chargereason ruby chargereason c charge reason of the debit memo, available values include late fee additional fee billing discrepancies picklist created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time customer customerid ruby accountid c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) debit memo number name name the debit memo number that will be displayed in a debit memo presentable to the end user text description description ruby description c additioanl description of the debit memo text end date enddate 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 id id the id of the record id last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time payment status paymentstatus ruby paymentstatus c the payment status available values include not transferred, transferred, paid, partial paid, canceled, refunded, partial refunded default value is not transferred picklist source id sourceid the id of the invoice that generates the debit memo text source type sourcetype the name of the object that generates the debit memo available values include invoice picklist start date startdate ruby startdate c this date is used to determine the start date of the billable period, where charges are to be billed date status status ruby status c the debit memo status available values include draft active canceled picklist tax amount taxamount ruby taxamount c the sum of all debit memo items' tax amount currency tax status taxstatus ruby taxstatus c the tax computation status available values include not calculated (default) calculated error text docid 64c6d58b9265016d34247835576e37adc954bc10 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 name debitmemoitem salesforce api name ruby debitmemoitem c fields the following table outlines all fields of the debit memo item object field name api name salesforce api name description type account id accountid ruby accountid c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) balance balance ruby balance c the remaining balance of the debit memo item after all payments, adjustments, and refunds are applied currency created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createdbydate the date when the record is created date time debit memo id debitmemoid ruby debitmemoid c the debit memo id bmasterdetail debit memo item number name name the debit memo item number that will be displayed in a debit memo presentable to the end user text end date enddate ruby enddate c the end date of the billable period date id id id the id of the record id last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time source id sourceid the id of the invoice item that generates the debit memo item text source type sourcetype the name of the object that generates the debit memo available values include invoiceitem picklist start date startdate the start date of the billable period date tax amount taxamount ruby taxamount c the tax amount currency transaction amount transactionamount ruby transactionamount c the 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 tax transactionamountwithouttax ruby transactionamountwithouttax c the 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 docid 64c6d58b9265016d34247835576e37adc954bc10 payment application represents how and when a payment transaction occurs to an invoice api name paymentapplication salesforce api name ruby paymentapplication c fields the following table outlines all fields of the payment application object field name api name salesforce api name description type applied amount transactionamount transactionamount c the payment amount applied currency applied date transactiondate transactiondate c the date when the payment applied date created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time credit memo id creditmemoid creditmemoid c the id of the credit memo applied to the invoice or unapplied to the invoice id id id externalid c the id of the record id invoice invoiceid invoiceid c the id of the invoice that the payment is applied to lookup ( invoice docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time negative invoice id negativeinvoiceid negativeinvoiceid c the id of the applied negative invoice applied to the invoice or unapplied to the invoice id payment application number name name the payment application number text payment id paymentid paymentid c the id of the payment record in the source system id payment method paymentmethod paymentmethod c the method of how the payment is processed available values include electronic, non electronic picklist payment number paymentnumber paymentnumber c the payment number of the payment record in the source system, e g , pay 001 text payment source paymentsource paymentsource c the name of the payment system available values include stripe, quickbooks, netsuite, nue, etc picklist payment type paymenttype paymenttype c the name of the object which processes a payment available values include payment, negativeinvoice, creditmemo, credit picklist record type recordtype recordtype c the type of the payment application available values include payment, refund picklist status status status c the status of the payment application available values include active, canceled picklist timestamp timestamp timestamp c the timestamp when the payment applied date time docid 64c6d58b9265016d34247835576e37adc954bc10 payment application item represents a payment transaction occurred to an invoice at the line level api name paymentapplicationitem salesforce api name ruby paymentapplicationitem c fields the following table outlines all fields of the payment application item object field name api name salesforce api name description type applied amount transactionamount transactionamount c the payment amount applied by this item currency applied date transactiondate transactiondate c the date when the payment applied date created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time credit memo item id creditmemoitemid creditmemoitemid c the id of credit memo item applied to the invoice or unapplied to the invoice id id id the id of the record id invoice item id invoiceitemid invoiceitemid c the invoice item that this payment is applied to id last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time negative invoice item id negativeinvoiceitemid negativeinvoiceitemid 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 invoice id payment application id paymentapplicationid paymentapplicationid c the id of the payment application id payment application item number name name the payment application item number text payment method paymentmethod paymentmethod c the method of how the payment is processed available values include electronic, non electronic picklist payment type paymenttype payment type c the name of the object which processes a payment available values include payment, negativeinvoice, creditmemo, credit picklist record type recordtype recordtypeid the type of the payment application available values include payment, refund picklist timestamp timestamp timestamp c the timestamp when the payment applied date time docid 64c6d58b9265016d34247835576e37adc954bc10 billing schedule represents a structured framework for organizing and managing the timing and execution of billing processes api name billingschedule 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 name api name salesforce api name description type auto activate autoactivate indicate whether auto activate the generated invoices boolean bill cycle day filter billcycledayfilter the filtered biiling cycle day, for example, 1st of month text catch up mode catchupmode indicate the mode when running a catch up billing schedule available values include generateinvoices simulation picklist clean catch up cleancatchup indicate whether the previous generated catch up type invoices or credit memos need to be deleted when runing a new catch up billing schedule boolean created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time created through createdthrough indicate how the billing schedule gets created available values include web application api picklist customer filter customerfilter the graphql conditions of the customer filters text customer filter for ui customerfilterforui the json formatted graphql conditions of the customer filters text id id the id of the record id include billing accounts includebillingaccounts indicate whether the associated billing accounts need to be billed together with their sales accounts in this billing schedule boolean include subsidiaries includesubsidiaries indicate whether the associated child accounts need to be billed together with their parent accounts in this billing schedule boolean invoice date invoicedate the invoice date displayed on the invoices date last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time last run date lastrundate the last billing run date of this billing schedule date order filter orderfilter the graphql conditions of the order filters text order filter for ui orderfilterforui the json formatted graphql conditions of the order filters text product filter productfilter the graphql conditions of the product filters text product filter for ui productfilterforui the json formatted graphql conditions of the product filters text recurring json recurringjson the json formattted regular expression capturing the billing job recurring schedule text recurring schedule recurringschedule a regular expression capturing the billing job recurring schedule text schedule number name the billing schedule number text schedule start date schedulestartdate the date that the first billing job is executed date schedule type scheduletype the type of the billing schedule available values include recurring on demand picklist split invoice by period splitbyperiod indicate whether to generate invoices and credit memos for each billing periods boolean status status the billing schedule status available values include draft active canceled completed picklist target date targetdate 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 timezone zoneid the billing schedule running timezone text docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 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 name billingjob 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 name api name salesforce api name description type billing schedule id billingscheduleid the id of the billing schedule which triggers the job lookup ( billingschedule docid 64c6d58b9265016d34247835576e37adc954bc10 ) catch up mode catchupmode indicate the mode when running a catch up billing schedule available values include generateinvoices simulation picklist clean catch up cleancatchup indicate whether the previous generated catch up type invoices or credit memos need to be deleted when runing a new catch up billing schedule boolean created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time credit memos generated creditmemosgenerated total credit memos generated in this billing job integer customer invoiced customerinvoiced total customers invoiced in this billing job integer end time endtime the time when the billing job ends date time error message errormessage the detailed error message if the current billing job has errors text execution time executiontime the time in milliseconds between the start date and end date integer id id the id of the record id invoice date invoicedate invoice date of this billing job date invoices generated invoicesgenerated total invoice generated in this billing job integer job number name the billing job number text last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time relations relations information of invoiced customers and their generated invoices and credit memos text split by period splitbyperiod indicate whether to generate invoices and credit memos for each billing periods boolean start time starttime the time when the billing job starts date time status status the status of the billing job available values include scheduled processing completed error canceled activated text target date targetdate target date of this billing job date docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 billing state tracks the invoicing statuses of the associated order product api name billingstate 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 name api name description type asset id assetid the id of the associated asset id asset number assetnumber the asset number, such as subscription number, asset number, entitlement number, etc text(255) asset type assettype the type of the associated asset, including subscription, asset, entitlement, etc picklist billed amount billedamount the cumulative amount invoiced for the associated order product currency billed quantity billedquantity the cumulative quantity invoiced for this order product decimal billed shipping and handling billedshipping the cumulative shipping and handling invoiced for this order product currency billing account billingaccountid the id of the billing account for the associated order product lookup (customer) created by createdbyid the user who created this record lookup (userprofile) created date createddate the date when the record is created date time id id the record id id invoiced until invoiceduntil the date up to which billing has been processed for the order product date last modified by lastmodifiedbyid the user who last updated the record lookup (userprofile) last modified date lastmodifieddate the date when the record is last updated date time next billing date nextbillingdate the date for the next billing cycle of the order product date order product orderproductid the associated order product masterdetail (orderproduct) order product number name the order product number text(80) product id productid the product id text(80) product name productname the product name text(255) product sku productsku the product sku text(80) sales account salesaccountid the id of the sales account for the associated order product lookup (customer) docid 64c6d58b9265016d34247835576e37adc954bc10 nue usage accelerator objects docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 raw usage represents a raw usage record resulted from a measuable consumption of a product or service api name rawusage 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 name api name salesforce api name description type created date createddate the date when the record is created date time customer id customerid the billing account id id id id the id of the record id last modified date lastmodifieddate the last date when the record is updated date time properties properties a json representation of the custom properties of the raw usage text quantity quantity the quantity of the raw usage decimal raw usage number name the raw usage number autonumber sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) subscription id subscriptionid the id of the subscription this raw usage is for id timestamp timestamp the timestamp of when the raw usage occurs date time transaction id transactionid indicate the group of raw usage data text usage id usageid the id of the generate usage after this raw usage gets rated lookup ( usage docid 64c6d58b9265016d34247835576e37adc954bc10 ) docid 64c6d58b9265016d34247835576e37adc954bc10 usage represents a rated usage record resulted from grouping of a set of usage records api name usage salesforce api name ruby nueusage c fields the following table outlines all fields of the usage object field name api name salesforce api name description type created date createddate createddate the date when the record is created date time credits applied creditsapplied ruby creditsapplied c the amount of applied credits for this usage decimal customer id customerid ruby account c the billing account id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) end time endtime ruby endtime c the end time of the raw usage window date time error code errorcode ruby errorcode c the error code when rating the usage if it has text error message errormessage ruby errormessage c the error message when rating the usage if it has text id id the id of the record id invoice id invoiceid ruby invoice c the associated invoice id id invoice item id invoiceitemid ruby invoiceitem c the associated invoice item id id invoice item number invoiceitemnumber ruby invoiceitemnumber c the associated invoice item number text invoice number invoicenumber ruby invoicenumber c the associated invoice number text is cash iscash ruby iscash c indicates whether the rated amount is cash type boolean last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time order number ordernumber ruby ordernumber c the number of the associated order of this usage text order product id orderproductid ruby orderproduct c the order product associated with the subscription id order product number orderproductnumber ruby orderproductnumber c the number of the associated order product of this usage text product id productid ruby product c the usage product id lookup ( product docid 64c6d58b9265016d34247835576e37adc954bc10 ) properties properties ruby properties c a json representation of the custom properties of the raw usage text quantity quantity ruby quantity c the consumed quantity of this usage decimal ratable time ratabletime the time offset when processing rating service date time rated amount ratedamount ruby ratedamount c the rated amount of the usage, returned by the rating engine decimal rated time ratedtime ruby ratedtime c the rated time of the usage record date time sales account id salesaccountid ruby salesaccountid c the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) start time starttime ruby starttime c the start time of the raw usage window date time status status ruby status c the usage status available values include open rated billed error picklist subscription id subscriptionid ruby subscription c the subscription id, which is always the latest version of the subscription id subscription number subscriptionnumber ruby subscriptionnumber c the subscription number text term end date termenddate ruby termenddate c the end date of the usage term, used by the rating engine date term start date termstartdate ruby termstartdate c the start date of the usage term, used by the rating engine date termed total quantity termedtotalquantity ruby termedtotalquantity c the total quantity already consumed in the usage term, including the quantity of the current usage, used by the rating engine decimal usage number name name the usage number autonumber window size windowsize ruby windowsize c the window size of the raw usage available values include day hour picklist zone id zoneid ruby timezone c the timezone information text docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 credit pool defines the system credit pool, which will be used as a template to generate account credit pool for each customer api name creditpool salesforce api name ruby creditpool c fields the following table outlines all fields of the credit pool object field name api name salesforce api name description type created by createdbyid createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate createddate the date when the record is created date time credit pool name name name the name of the credit pool text credit type id credittypeid ruby credittype c the id of the credit type lookup ( credittype docid 64c6d58b9265016d34247835576e37adc954bc10 ) id id id the id of the record id is default isdefault ruby isdefault c determines if the current credit pool is used as system default credit pool boolean last modified by lastmodifiedbyid lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate lastmodifieddate the last date when the record is updated date time docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 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 name accountcreditpool 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 name api name salesforce api name description type account credit pool number name the number of the account credit pool text balance balance the balance of the account credit pool decimal created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time credit pool id creditpoolid the id of the credit pool lookup ( creditpool docid 64c6d58b9265016d34247835576e37adc954bc10 ) credit type id credittypeid the id of the credit type lookup ( credittype docid 64c6d58b9265016d34247835576e37adc954bc10 ) customer id customerid the customer id that the credit pool belongs to lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) id id the id of the record id last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time status status the status of the account credit pool, available options active picklist docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 credit type represents the type of credit, which can be credit or cash api name credittype 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 name api name salesforce api name description type created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time credit type category the category of the credit type, available values include credit cash picklist credit type name name the display name of the credit type text id id the id of the record id last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time status status indicates whether the credit type is active, available options active, inactive picklist docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 credit represents the credit issued by a credit burn down product or service the customer purchased api name credit 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 name api name salesforce api name description type account pool id accountpoolid the account pool id that the credit belongs to id amount amount the total amount of the credit decimal asset id assetid the id of the associated asset id asset number assetnumber the number of the associated asset text asset type assettype the type of the associated asset picklist balance balance the balance of the credit decimal cash amount cashamount the cash amout of the credit currency created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time credit number name the number of the credit text credit type id credittypeid the id of the credit type lookup ( credittype docid 64c6d58b9265016d34247835576e37adc954bc10 ) customer id customerid the customer id that the credit belongs to lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) end date enddate the expiration date of the credit date end time endtime the expiration datetime of the credit date time id id the id of the record id issue date issuedate the date when the credit is issued date last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time order product id orderproductid the id of the associated order product lookup ( orderproduct docid 64c6d58b9265016d34247835576e37adc954bc10 ) start date startdate the start date of the credit date start time starttime the start datetime of the credit date time time zone timezone the time zome information when the credit is issued text docid 64c6d58b9265016d34247835576e37adc954bc10 docid 64c6d58b9265016d34247835576e37adc954bc10 credit flow represents the credit inflow (grants) and outflow (consumption) of a certain amount of credits api name creditflow 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 name api name salesforce api name description type account pool id accountpoolid the account pool id that the credit flow belongs to id balance balance the balance of the credit decimal created by createdbyid the user who created the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) created date createddate the date when the record is created date time credit end date creditenddate the expiration date of the credit date credit flow number name the number of the creidt flow text credit id creditid the id of the associated credit id credit number creditnumber the number of the associated credit text credit start date creditstartdate the start date of the credit date credit type id credittypeid the id of the credit type lookup ( credittype docid 64c6d58b9265016d34247835576e37adc954bc10 ) customer id customerid the customer id that the credit flow belongs to lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) id id the id of the record id last modified by lastmodifiedbyid the last user who updated the record lookup ( userprofile docid 64c6d58b9265016d34247835576e37adc954bc10 ) last modified date lastmodifieddate the last date when the record is updated date time record type recordtype the record type of the credit flow, available options inflow / outflow picklist sales account id salesaccountid the customer id lookup ( customer docid 64c6d58b9265016d34247835576e37adc954bc10 ) subscription number assetnumber the number of the associated asset text transaction amount transactionamount the transaction amount included in the credit flow decimal transaction date transactiondate the date when the transaction occurs date transaction source transactionsource the source object to consume the credit, available options usage / payment application item text transaction source id transactionsourceid the source object id associated with the credit flow text transaction type transactiontype the transaction type of the credit flow, available options issue / consume / cancel / expire picklist docid 64c6d58b9265016d34247835576e37adc954bc10