Object Model Overview

nue's object model is as an extension of the standard objects available in salesforce while incorporating custom objects specifically tailored to nue's unique business capabilities the model contains essential entities such as accounts, products, orders, invoices, credits, usage, and more, allowing nue to effectively manage its sales, customer success operations, and financial transactions by leveraging both standard salesforce objects and custom objects, nue ensures seamless integration of its proprietary business logic with the robust capabilities provided by the salesforce platform this integration enables nue to streamline processes, enhance productivity, and drive meaningful insights to propel its business forward the following diagram provides an overview of nue's object model across multiple nue applications, including price builder, lifecycle manager, billing and usage accelerator nue is a dual platform system, where objects reside in both salesforce and nue cloud services objects and relationships marked in teal are standard objects in salesforce with nue extensions these objects, with the exception of opportunity and opportunity products, quote and quote line items, have their mirrored copies in nue platform objects and relationships marked in purple are nue objects, and they are created as custom objects in nue on salesforce note in the nue object model, when two objects have a many to many relationship, an intersection object is created to capture and store the relationship for instance, the account and credit pool objects have a many to many relationship, and to represent this relationship, an intersection object called account credit pool is utilized however, to maintain clarity in the object model diagram, these intersection objects are not depicted their presence and purpose are understood within the model's underlying structure but omitted from the visual representation to ensure simplicity and ease of understanding nue objects the following table outlines all nue objects, organized by applications access object metadata nue users can access the metadata including relationships and fields for all business objects in nue users can login to nue and navigate to settings → business objects, and see a list of objects in nue for any object in the list, if salesforce api name is not empty, the object has salesforce as the primary data source object metadata api users can also access object metadata using nue's object metadata api https //api docs nue io/#metadata get a list of all objects users can describe all nue objects via the following metadata api https //api docs nue io/#describe all objects curl location 'https //api nue io/metadata/objects' \\ \ header 'apiaccesskey {{apiaccesskey}}' \\ \ header 'authorization bearer {{token}}' get the definition of an object users can get the object fields and relationships definition of a particular object using the following metadata api https //api docs nue io/#get object definition \# you can also use wget curl x get https //api nue io/v1/metadata/objects/{{objectapiname}} \\ h 'accept / ' \\ h 'authorization bearer {{access token}}' price builder the following table outlines the objects in the price builder for more detailed object model information of nue price builder, please reference nue object model billing & usage accelerator docid\ bbq1oanzrrtmonpeuabak object name object api name salesforce object name description nue object model price builder docid\ xql 6fn6u4cbqbvuobuan uom ruby uom c represents a definite magnitude of a quantity nue object model price builder docid\ xql 6fn6u4cbqbvuobuan creditconversion ruby creditconversion c defines the conversion rate between a product's uom quantity dimension and a credit nue object model price builder docid\ xql 6fn6u4cbqbvuobuan product product2 defines a product or service that is manufactured or provisioned for sale nue object model price builder docid\ xql 6fn6u4cbqbvuobuan productoption ruby productoption c defines the product optionality in a bundle product nue object model price builder docid\ xql 6fn6u4cbqbvuobuan feature ruby feature c defines a set of products a product group can be associated with more than one bundle product nue object model price builder docid\ xql 6fn6u4cbqbvuobuan productfeature ruby productfeature c defines a set of product functionalities a feature can be associated with multiple products, while a product may contain multiple features nue object model price builder docid\ xql 6fn6u4cbqbvuobuan bundlesuite ruby bundlesuite c represents a list of active bundle products, ranging from bundles with basic product offering to bundles with more advanced product offerings nue object model price builder docid\ xql 6fn6u4cbqbvuobuan bundlesuitebundle ruby bundlesuitebundle c defines the relationship between a bundle suite and a bundle product nue object model price builder docid\ xql 6fn6u4cbqbvuobuan productpricedimension ruby productpricedimension c represents a price tag's association with a product nue object model price builder docid\ xql 6fn6u4cbqbvuobuan productoptionpricedimension ruby productoptionpricedimension c represents a price tag's association with a product option in a bundle product product relationship productrelationship ruby productrelationship c represents a product's relationship with another product, e g , upgrade, inclusion, exclusion nue object model price builder docid\ xql 6fn6u4cbqbvuobuan featurepricedimension ruby featurepricedimension c represents a price tag's association with a product group nue object model price builder docid\ xql 6fn6u4cbqbvuobuan pricebook pricebook2 represents a list of sellable products and their prices nue object model price builder docid\ xql 6fn6u4cbqbvuobuan pricebookentry pricebookentry represents a sellable product with its price listed in a price book nue object model price builder docid\ xql 6fn6u4cbqbvuobuan pricedimension ruby pricedimension c defines a tiered pricing or discounting scheme, which can be a quantity based tiering, or term based tiering nue object model price builder docid\ xql 6fn6u4cbqbvuobuan pricetier ruby pricetier c defines a price or discount tier, which can be either a flat fee tier, or a per unit tier lifecycle manager the following table outlines the objects in lifecycle manager for more detailed object model information of nue lifecycle manager, please reference nue object model nue lifecycle manager docid padhf0czdjypqf km6m5 object name object api name salesforce object name description customer customer account represents an individual customer account, partner or organization contact contact contact represents a contact, who is a person associated with a customer opportunity n/a opportunity represents a sales deal in progress opportunityproduct n/a opportunitylineitem represents a product or service you sell in a sales opportunity quote n/a quote represents proposed prices, quantities and terms of products or services you sell in a sales deal quote line item n/a quotelineitem represents the proposed price, quantity and term of a product or service included in a quote line bucket n/a ruby linebucket c represents a set of quote line items bucketed together for a purpose order order order represents a booking transaction between a company and a customer to provision services or deliver products with contracted quantities, prices, and terms order product orderproduct orderitem represents the price, quantity, and term of a contracted product or service in an order line price tag linepricetag ruby linepricedimension c records the relationship between a line item (a quote line item, or an order product) and a price tag, representing which price tag(s) are applied to which line item(s), and their price impacts subscription subscription ruby subscription c represents a recurring product or service provisioned for a customer a subscription of a product bundle may have children subscriptions and other assets and entitlements asset asset asset represents a physical asset fulfilled for a customer entitlement entitlement ruby entitlement c represents a service entitlement provisioned for a customer asset order product assetorderproduct ruby assetorderproduct c records the relationship between a booking transaction (an order product) and an asset in the general term, which can be a physical asset, a subscription, and an entitlement billing accelerator the following table outlines the objects in the billing accelerator for detailed information, please refer to nue object model billing & usage accelerator docid\ bbq1oanzrrtmonpeuabak object name object api name salesforce object name description invoice invoice ruby invoice c represents a customer invoice that contains the charges of products or services in a specific billable period invoice item invoiceitem ruby invoiceitem c represents a line item in the invoice that contains the charge of a particular product or service a customer consumed in specific billing period credit memo creditmemo ruby creditmemo c represents a customer credit memo that contains the amount reduced for products or services in a specific billable period credit memo item creditmemoitem ruby creditmemoitem c represents a line item in the credit memo that contains the amount reduced for a particular product or service a customer ordered in specific billing period debit memo debitmemo ruby debitmemo c represents a financial record reflecting deductions or adjustments, aiding in financial reconciliation debit memo item debitmemoitem ruby debitmemoitem c represents a line item within a debit memo, specifying the details of deductions or adjustments made, facilitating accurate financial tracking payment application paymentapplication ruby paymentapplication c represents how and when a payment transaction occurs to an invoice payment application item paymentapplicationitem ruby paymentapplicationitem c represents a payment transaction occurred to an invoice at the line level billing state billingstate n/a tracks the invoicing statuses of the associated order product usage accelerator the following table outlines the objects in the usage accelerator for detailed information, please refer to nue object model billing & usage accelerator docid\ bbq1oanzrrtmonpeuabak some objects do not have their mirrored copy in salesforce object name object api name salesforce object name description raw usage rawusage represents a raw usage record resulted from a measuable consumption of a product or service usage usage ruby nueusage c represents a rated usage record resulted from grouping of a set of usage records credit pool creditpool ruby creditpool c defines the system credit pool, which will be used as a template to generate account credit pool for each customer account credit pool accountcreditpool represents the credit pool for each customer, which contains the credits issued to the customer and the flows of how the credit balance changes credit type credittype represents the type of credit, which can be credit or cash credit credit represents the credit issued by a credit burn down product or service the customer purchased credit flow creditflow represents the credit inflow (grants) and outflow (consumption) of a certain amount of credits