Standard Objects

Data Model Diagram

Standard Objects 

Object Name Description
ACCOUNT Primary object representing the customer. The account has a very basic and minimal definition and typically contains a relationship with a BILLING_PROFILE record where the billing details are defined. Use the account object as a starting point for your customer hierarchy.
ACCOUNT_PACKAGE The ACCOUNT_PACKAGE is a junction between packages and accounts. This defines the association of a package instance for a given account. The package instance will have a child. PACKAGE_PRODUCT instances will also link to specific pricing for the instances of the products defined for the package.
ACCOUNT_PRODUCT This object is used as a junction between the product and account. It represents the instance of a product when provisioned to an account. The ACCOUNT_PRODUCT will also link to pricing for the instance.
ACTIVITY This object contains the billable events, invoice line items, etc as they relate to usage and subscription events in the system. ACTIVITY may be rated or not based on the state of the record's life cycle.
ACTIVITY_COLLECTOR Primary configuration for setting up usage-based data collection. This is sometimes known as "Mediation" and is used to define how product usage collected from other systems is routed, transformed and rated relative to customers, pricing contracts and products.
BILLING_PROFILE The primary object used to capture billing information for an account such as, invoice cycle, dunning, invoice template, billing address, and payment information.
COLLECTOR_FIELDS Child of the ACTIVITY_COLLECTOR object. This entity captures the system and custom fields mapping to the source, as well as input data for metered usage.
CONTRACT Used to aggregate and define start and end dates for a collection of rates, products and packages associated with an account.
CONTRACT_RATE Child of the CONTRACT object, this is used to define a rate for a given product. Use this where a product instance is not required to simply rate recurring usage and subscription charges based on a simple quantity.
COUNTRY_CODE Used primarily for telecommunications providers, the country code helps define country-specific rates and behaviors.
COUNTRY_CODE_MAP The country code map object is used to map telephone number fragments to specific country codes. This feature is primarily reserved for telecommunications providers, but can be adapter to a wide range of purposes.
CREDIT This object is used to off-set account balances by providing a credit or a negative charge. Credits can be applied to the account in general or to specific items such as an invoice.
CREDIT_ALLOCATION Used to define how a CREDIT is allocated. For example, use this to define which specific invoices this CREDIT will be applied to.
CREDIT_TYPE List of values for reporting purposes. Used to capture and categorize the types of credits issued for an organization.
CURRENCY Used to define the currencies used for your organization.
DESTINATION_COUNTRY_CODE Primarily used by telecom providers, this entity is used to define rating for origination and destination pairs in a phone call.
DUNNING_INTERVAL Used to define the aging level associated with a particular dunning action. For example, your would use this to configure the system to send a dunning letter of a configured type at 30 days past the due date. Dunning intervals are associated with specific dunning "Flows". A dunning flow can be assigned to an account's billing profile.

Represents an object or table in the system. This is part of the application's metadata and contains descriptive information used by the application and in integration

ENTITY_FIELD Describes the fields associated with a given ENTITY and is similar to fields or columns in a database table. This is part of the application's metadata and contains descriptive information used by the application and in integration.
ENTITY_FIELD_ROLE Part of the security model. Describes the access level for a particular field for a given role
ENTITY_FIELD_VALUES Contains the list of values for a pick-list field.
INVOICE Used as the primary means of capturing positive financial transactions. Invoices can have various stages such as current and closed. The invoice will contain a summary of the rated ACTIVITY associated with an invoice as usage is collected and rated in real time such that a current invoice will show rated activity throughout the invoicing cycle.
INVOICE_TEMPLATE Parent object for constructing an invoice template. Primarily contains invoice header configurations as well as branding and styling information.
LABEL_VERSION All textual elements that comprise the application are represented by labels in order to support multiple languages and terminologies. The LABEL_VERSION object will contain language-specific versions of a given label associated with a field, tab, or other element of the back-office application.
LANGUAGE Used to define the languages used by the application for localization and multi-lingual support.
ORIGINATION_COUNTRY_CODE Primarily used by telecom providers, this entity is used to define rating for origination and destination pairs in a phone call.
PACKAGE Used to aggregate a collection of products in order to define special pricing and behaviors as they relate the the package.
PACKAGE_PRODUCT The instance of a product as it relates to a package. Here, special pricing as well as rating behavior can be defined specific to the context of the parent PACKAGE.
PARENT_PACKAGE_PRODUCT Used to maintain a hierarchy of products within a package.
PAYMENT Primary entity for capturing payment transactions in the system. These include electronic, automated and manual payment types along with merchant provider details where applicable.
PAYMENT_ALLOCATION Used to allocate payments to invoices/orders to off-set the balance and aging.
PAYMENT_TYPE The domain of payment types such as: CREDIT CARD, CHECK, BANK UPLOAD, ACH, WIRE.
PRICING Used to price products and product instances. This is an independent entity so that it can support tiered pricing.
PRODUCT The primary object used to aggregate product details such as rating method, name, default pricing, etc.. This is the configuration that comprises the product catalog.
RATE_CLASS Used to define a global set of rate plans that can be applied to several accounts. Use this object to simplify provisioning and to manage rates globally for all subscribers of the given rate class.
RATING_METHOD The method used to define rating behavior. Examples are Subscription, Usage, One Time Charge, Fee. Rating method will contain specific attributes that vary per rating method type.
RATING_METHOD_TYPE The types of rating methods supported by the system. i.e. Subscription, Usage, One Time Charge, Fee.
REFUND Use a refund to return funds to a customers credit card or to apply a "Credit" to the account for a given charge.
REFUND_TYPE The type of refund being applied. This will drive behavior based on whether the refund is being applied to a credit card transaction or simply being used to offset a balance manually.
SHARING_GROUP Used to restrict the records visibility to users subscribed to a named group.
STATEMENT_TEMPLATE The template for rendering the statement in a readable form.
TAX_DETAIL Links the details of taxation records to invoice activity
TIME_ZONE List of all known time zones. Used to define localization for a given customer's billing profile and to normalize the data that appears on their invoices and other communications.
USER The users that log into the back-office application
VENDOR Used in a re-seller scenario primarily. Can be leveraged to differentiate billing identifiers used by different vendors.
Have more questions? Submit a request


Powered by Zendesk