Qodex.ai

API CustomerBill

Number of APIs: 14

TMF API Reference: TMF 678 - Customer bill Management

Release: 19.5 - December 2019

The Customer Bill Management API allows to find and retrieve one or several customer bills (also called invoices) produced for a customer. A customer bill is an electronic or paper document produced at the end of the billing process. The customer bill gathers and displays different items (applied customer billing rates generated during the rating and billing processes) to be charged to a customer. It represents a total amount due for all the products during the billing period and all significant information like dates, bill reference... This API provides also operations to find and retrieve the details of applied customer billing rates presented on a customer bill. Finally, this API allows to request in real-time a customer bill creation and to manage this request.

Resources

  • customerBill
  • appliedCustomerBillingRate
  • customerBillOnDemand
  • billingCycle

Operations

Customer Bill Management API performs the following operations : - Retrieve a customer bill or a collection of customer bills depending on filter criteria. - Partial update of a customer bill (for administration purposes). - Retrieve an applied customer billing rate or a collection of applied customer billing rates depending on filter criteria. - Create a customer bill on demand request, retrieve one or a collection of customer bill on demand request(s) depending on filter criteria.

  • Manage notification of events on customer bill and customer bill on demand.

Copyright © TM Forum 2018. All Rights Reserved.

  1. applied Customer Billing Rate - List or find AppliedCustomerBillingRate objects GET {{baseUrl}}/appliedCustomerBillingRate?fields=veniam aliqua&offset=-66130548&limit=-66130548

  2. customer Bill On Demand - Creates a CustomerBillOnDemand POST {{baseUrl}}/customerBillOnDemand

  3. customer Bill On Demand - Retrieves a CustomerBillOnDemand by ID GET {{baseUrl}}/customerBillOnDemand/:id?fields=veniam aliqua

  4. applied Customer Billing Rate - Retrieves a AppliedCustomerBillingRate by ID GET {{baseUrl}}/appliedCustomerBillingRate/:id?fields=veniam aliqua

  5. hub - Unregister a listener DELETE {{baseUrl}}/hub/:id

  6. customer Bill - List or find CustomerBill objects GET {{baseUrl}}/customerBill?fields=veniam aliqua&offset=-66130548&limit=-66130548

  7. customer Bill On Demand - List or find CustomerBillOnDemand objects GET {{baseUrl}}/customerBillOnDemand?fields=veniam aliqua&offset=-66130548&limit=-66130548

  8. customer Bill-{id} - Retrieves a CustomerBill by ID GET {{baseUrl}}/customerBill/:id?fields=veniam aliqua

  9. customer Bill-{id} - Updates partially a CustomerBill PATCH {{baseUrl}}/customerBill/:id

  10. bill Cycle - List or find BillCycle objects GET {{baseUrl}}/billCycle?fields=veniam aliqua&offset=-66130548&limit=-66130548