Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Hide If
special@authenticated
Note
titleTo access this API specification you wil need to be logged in

To login with your TM Forum account please click on the Login button below

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

Don't have an account? You can register by clicking here:

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue

Show If
special@authenticated

The Billing API provides standardized mechanism for billing account, bill item and settlement note advice management either in B2B or B2B2C contexts.
It allows creation, update and retrieval of a billing account either in a B2B2C relationship context (creation of mass market customer billing account within a "Billing on Behalf of" process for example) or in a B2B context (creation of a billing account for a partner or B2B customer).
It also allows creation and query of bill items allowing partners or B2B customer to check their invoice.
In addition, it allows notification of settlement note advice to partners who can, then, query it.
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 its identifier and name, rating type (prepaid, postpaid), status, identifier of related customer account, billing cycle information, bill format and presentation media (post mail, email, web page), billing currency, billing account balance identifier, payment means (e.g. credit card) related party reference and role (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 bill item attributes are its identifier, creation date, description (additional data displayed on the bill), type of charge (recurring, one time or usage), currency code, taxes and amounts related information (tax included amount, tax excluded amount, tax rate), identifier and type of the concerned service
  • Settlement Note Advice
    • The settlement is about transferring money receiving by a partner to another partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.
    • Main settlement note advice attributes are its identifier, Creation date, description, due date, , taxes and amounts related information (tax included amount, tax excluded amount, tax rate, etc.), currency code, settlement method, receiver and issuer, settlement note Item related to a product information (identifier, description, quantity, taxes and amounts related information, product information)
  • 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 CustomerBill, supported by the associated bill format. For example, post mail, email, web page.


Billing API performs the following operations on the above mentioned resources

  • On billing account
    • Retrieval of a billing account or a collection of billing accounts
    • Partial update of a billing account
    • Creation of a billing account
    • Notification of billing account state change
  • On Bill Item (Applied Customer Billing Charge)
    • Creation of a bill item
    • Retrieval of a bill item or a collection of bill items
  • On Settlement note advice
    • Retrieval of a settlement note advice or a collection of settlement note advices
    • Notification of a settlement note advice
  • On Customer Billing Cycle Specification
    • Retrieval of a customer billing cycle specification
    • Creation of a customer billing cycle specification
    • Deletion of a customer billing cycle specification
  • On Customer Bill Format
    • Retrieval of a customer bill format
    • Creation of a customer bill format
    • Deletion of a customer bill format
  • On Customer Bill Presentation Media
    • Retrieval of a customer bill presentation media
    • Creation of a customer bill presentation media
    • Deletion of a customer bill presentation media
 

© TM Forum 2015. All Rights Reserved.