Billing API manages the following Data resources:
- Billing account
- A Billing Account is a detailed description of a customer's bill structure
- Main billing Account attributes are :
- Unique identifier of the billing account
- short descriptive name
- Rating type (prepaid, postpaid)
- Status
- Period of validity
- Identifier of related customer account
- Customer Billing Cycle Specification: A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle
- Customer Bill Format: A detailed description of the way in which a customer's bill is presented
- Customer Bill Presentation Media: A means of communicating a Customer Bill, supported by the associated bill format. For example, post mail, email, web page
- Billing Currency
- Identifier and name of Billing Account Balance
- Payment Means which defines a specific mean of payment (e.g. direct debit with all details associated)
- Related Party reference and role which identify the party playing a role within billing account (Invoice responsible, payer, etc.)
- Bill item (aka Applied Customer Billing Charge in SID terminology)
- A bill item is an amount, usually of money, for which a person or an organization is financially liable.
- Main attributes are
- Unique identifier of the applied customer billing charge
- Creation date of the applied customer billing charge
- Description i.e. additional data to be displayed on the customer bill for this applied customer billing charge
- Type of the applied customer billing charge (recurring, one time or usage)
- Currency Code
- All taxes included amount to be charged on the customer bill (expressed in the given currency)
- Tax excluded amount to be charged on the customer bill (expressed in the given currency)
- Tax Rate i.e. amount of money levied on the price of a product by a legislative body.
- Identifier and type of the concerned service
- Settlement Note Advice
- The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.
- Main attributes are
- unique identifier for the settlement note advice
- Creation date of the settlement note advice
- free description text
- Date at which the due amount should have been paid to the partner
- Date of the tax
- Currency Code
- All taxes excluded amount (expressed in the given currency)
- All taxes included amount (expressed in the given currency)
- Tax Item for each tax rate and tax type used in the settlement note
- Settlement Method (the way in which the issuer provides the payment)
- Receiver (Party who will receive the settlement note)
- Issuer (Party who will issue the settlement note)
- Issuer and receiver Tax Registration number
- image of the settlement note
- Settlement Note Item which provides information about amount settled for a product identified by its catalog reference
- Unique number assigned to the settlement note item
- Unique identifier of the settlement note item
- A free description text for the settlement note item
- Quantity
- Tax excluded unit price to be applied on the given quantity
- Tax excluded amount equal to quantity * tax Excluded Unit Price
- All taxes included amount equal to tax Excluded Amount + tax Amount
- Identification number assigned to the product
- Name of the product