TMF666 Account Management
Aria gained conformance certification from TM Forum for this API in November 2021.
TMF666 Account Management API provides:
- A standardized mechanism for the management of party, billing, and settlement accounts, as well as for financial accounting either in B2B or B2B2C context.
- Aria Billing Cloud uses its extensible fields to distinguish these four types of accounts within the hierarchical account structure.
- A method for creating and retrieval of account information from Aria Billing Cloud.
- A method for creating and retrieval of billing details from Aria Billing Cloud and present it in a format and media specified.
The full API specification for TMF666 can be found on the TM Forum site: TMF666 Account Management API REST Specification R19.0.1 | TM Forum
The Tables below show the API mandated resource along with mandated operations for conformance.
PartyAccount, BillingAccount, FinancialAccount, SettlementAccount
| 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 |
{Party,Billing,Financial,Settlement}Account Operations
- Create an Account
- This operation creates an Account within Aria Billing Cloud.
- Retrieve Account
- This operation retrieves a list of Accounts from Aria Billing Cloud.
- Retrieve Accounts by filters
- This operation retrieves Accounts based on a variety of filter conditions from Aria Billing Cloud.
BillingCycleSpecification
| 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 |
BillingCycleSpecification Operations
- Create Billing Cycle Specification
- This operation creates a Billing Cycle Specification within Aria Billing Cloud’s rate schedules.
- Retrieve Billing Cycle Specification
- This operation retrieves a list of Billing Cycle Specifications from Aria Billing Cloud Billing Cloud’s rate schedules.
- Retrieve bill formats by filters
- This operation retrieves Billing Cycle Specifications based on a variety of filter conditions from Aria Billing Cloud Billing Cloud’s rate schedules.
BillFormat
| 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 |
BillFormat Operations
- Create a bill format
- This operation creates a bill format within Aria.
- Retrieve bill formats
- This operation retrieves a list of bill formats from Aria.
- Retrieve bill formats by filters
- This operation retrieves bill formats based on a variety of filter conditions from Aria.
BillPresentationMedia Operations
| Operation | Mandatory/Optional | Comments |
|---|---|---|
| GET | M |
Response Status Code 200 if successful |
| Response Status Code 404 if not found |
BillPresentationMedia Operations
- Retrieve Bill Presentation Media
- This operation retrieves a list of Bill Presentation Media from Aria Billing Cloud.