TMF678 Customer Bill Management
Aria gained conformance certification from TM Forum for this API in December 2021.
TMF678 Customer Bill Management API provides:
- The creation and management of invoices and pending Invoices within Aria Billing Cloud.
- To retrieve one or several customer invoices within Aria Billing Cloud.
- To retrieve the details of the applied customer billing rates for an invoice or pending invoice within Aria Billing Cloud.
Invoices, in Aria Billing Cloud, are normally created during a daily batch run, on-demand by the customer or by other events such as an account termination. This billing process applies the appropriate recurring charges, usage rates, one-time charges, discounts, and taxes to produce the invoice.
The full API specification for TMF678 can be found on the TM Forum site: TMF678 Customer Bill Management API User Guide v4.0.1 | TM Forum
The Tables below show the API mandated resource along with mandated operations for conformance.
CustomerBill
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found | ||
| PATCH | M | Status Code 200 if resource created |
CustomerBill Operations
-
Update a Customer Bill
-
This operation updates an invoice on an account within Aria Billing Cloud.
-
-
Retrieve Customer Bill
-
This operation retrieves a list of invoices from Aria Billing Cloud.
-
-
Retrieve Customer Bill by filters
-
This operation retrieves invoices based on a variety of filter conditions from Aria Billing Cloud.
-
CustomerBillOnDemand
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found | ||
| POST | M | Status Code 201 if resource created |
CustomerBillOnDemand Operations
- Create Customer Bill On Demand
- This operation creates an order and invoice within Aria Billing Cloud
- Retrieve Customer Bill On Demand
- This operation retrieves a list of invoices from Aria Billing Cloud
- Retrieve Customer Bill on Demand by filters
- This operation retrieves invoices based on a variety of filter conditions from Aria Billing Cloud
AppliedCustomerBillingRate
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found |
AppliedCustomerBillingRate Operations
- Retrieve Applied Customer Billing Rate
- This operation retrieves a list of applied rates from Aria Billing Cloud.
- Retrieve Applied Customer Billing Rate by filters
- This operation retrieves the applied rate for invoices or pending invoices based on a variety of filter conditions from Aria Billing Cloud.