Glossary

Key terms and definitions used in Billerang. Terms are alphabetized. Where a term maps to a specific entity or API concept, the mapping is noted in parentheses.

Term	Definition
Accounting Code	The ledger code attached to an accounting article. It routes revenue from a rated transaction to the right account in the general ledger, and distinguishes liability accounts (deferred revenue) from regular revenue accounts.
Aggregation Rule	The rule that decides how rated transactions are grouped into invoice lines on an invoice. Transactions can be aggregated by article, by subscription, by unit price, or left unaggregated (one line per transaction).
Article	The billing-facing wrapper around a charge template. An article carries the accounting code, tax class, and invoice sub-category used to present a charge on an invoice, decoupling how a charge is priced from how it is displayed and posted to the ledger.
Auditable	The base trait every business entity carries: created date, creator, last-updated date, and last updater. It underlies the audit trail shown in every edit page's sidebar card.
Bill Run	A scheduled or on-demand job that processes eligible billing accounts for a billing cycle, generates rated transactions into invoices, and moves them from draft to validated.
Bill Run Process Type	The billing account selection strategy for a bill run: by billing account, by billing account list, or by invoice date. It determines which accounts are picked up in a given run.
Billing Account	The account that receives invoices. It sits below a customer account in the hierarchy, and carries the billing cycle, payment method, and invoicing preferences for a group of subscriptions.
Billing Cycle	The configuration that tells a bill run when and how often to invoice a billing account: invoicing day, calendar, and bill run process type.
BusinessEntity	The base class for any entity identified by a unique business code and description, as opposed to only a database id. Sellers, offer templates, and charge templates are all BusinessEntity subclasses.
CDR	Call Detail Record. Raw usage data from a network or platform (call length, data volume, transaction count) that mediation converts into EDRs before rating.
Charge	The pricing unit attached to a service or product. Billerang has three charge families: Recurring (billed every period on the billing cycle), One-shot (billed once, e.g. an activation fee), and Usage (billed per unit of consumption, driven by rated EDRs).
Connect Portal	The tenant onboarding and self-service portal that provisions a new Billerang tenant, its Keycloak realm, and its initial provider configuration.
Custom Field	A dynamically defined field attached to any entity without a schema change. Custom field values are stored in cf_values and are readable via entity.getCfValue("fieldCode").
Customer Account	The financial and payment layer of the account hierarchy, sitting between customer and billing account. It holds the payment method, currency, and credit category used across all billing accounts underneath it.
Discount Plan	A reusable set of discount rules (percentage, fixed amount, or formula-based) that can be attached at the offer, product, or subscription level. Multiple discount plans can apply to the same subscription at once.
EDR	Event Detail Record. The normalized usage event Billerang rates against a charge, either produced directly by an API call or derived from a CDR during mediation.
Invoice	The billing document generated from a set of rated transactions for a billing account. It groups invoice lines, computes tax, and is rendered to PDF (or a structured e-invoice) from a billing template.
Invoice Line	A single line on an invoice, the result of aggregating one or more rated transactions under an aggregation rule.
Offer Template	The catalog-level product definition a customer subscribes to. An offer template bundles one or more service or product templates, each carrying its own charges.
Order	A commercial request to add, change, or terminate one or more subscriptions. Orders drive subscription creation and carry their own validation, pricing preview, and document generation.
Price Plan Matrix	The pricing table attached to a charge template. It resolves the unit price from criteria such as date, quantity tier, currency, or custom attributes, and can use a fixed value or a formula.
Quarantine	The holding state for EDRs or CDRs that failed validation or rating. Quarantined records are visible for review and can be corrected and resubmitted instead of being silently dropped.
Query API	The read-only v1 endpoint (GET/POST /api/v1/query/{entity}) that powers tables, pickers, and forms. It replaces the legacy generic API for all read paths.
Quote	A pre-order proposal with its own pricing and validity period. A quote can be converted into an order once accepted.
Rated Transaction (RT)	The priced result of rating a charge, whether recurring, one-shot, or usage-driven. Rated transactions are the atomic unit that bill runs aggregate into invoice lines.
Rating	The process of applying a price plan matrix to a charge occurrence (a billing cycle tick, a one-shot trigger, or a rated EDR) to produce a rated transaction.
Reservation	A temporary hold placed against a wallet balance during real-time usage rating, so a session in progress cannot overspend a prepaid balance before it is confirmed or released.
Seller	The legal entity issuing invoices. A seller carries its own invoice sequences, legal details, and trading currencies, and sits at the top of the account hierarchy.
Split Billing	Splitting the rated transactions of a single subscription across more than one billing account, so different parts of the same subscription are invoiced separately.
Subscription	The active instantiation of an offer template for a billing account. It carries the services or products actually contracted, their activation and termination dates, and the charges currently running.
Tax Class	The classification that determines which tax rate applies to a charge, via a tax mapping to a tax category and rate.
Tenant / Provider	The isolation unit in a multi-tenant Billerang deployment. Each tenant (provider) has its own data partition and, typically, its own Keycloak realm. See Multi-Tenancy.
Trading Currency	A currency a seller is authorized to invoice in, alongside the seller's functional currency. Price plan matrices and rated transactions can resolve amounts per trading currency.
Usage	Consumption-based activity (calls, data, API requests) reported as EDRs or CDRs and rated against usage charges, as opposed to flat recurring or one-shot charges.
Wallet	The running balance associated with a subscription, either prepaid (used to fund usage in real time) or postpaid (an accumulator tracked for reporting and thresholds).
Wallet Operation	An individual debit or credit against a wallet, created when a charge is rated. Wallet operations are the internal counterpart of a rated transaction before it is confirmed.

See also

• Data Model for how these entities relate.
• Multi-Tenancy for tenant and provider isolation.
• eInvoicing Overview for invoice and e-invoice specifics.