Question 1

What can I do with the Account Management API?

Accepted Answer

The Account Management API provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts.List or find PartyAccount objects (GET /partyAccount). Creates a PartyAccount (POST /partyAccount). Retrieves a PartyAccount by ID (GET /partyAccount/{id}). Updates partially a PartyAccount (PATCH /partyAccount/{id}). Deletes a PartyAccount (DELETE /partyAccount/{id}). List or find BillingAccount objects (GET /billingAccount). Creates a BillingAccount (POST /billingAccount). Retrieves a BillingAccount by ID (GET /billingAccount/{id}). Updates partially a BillingAccount (PATCH /billingAccount/{id}). Deletes a BillingAccount (DELETE /billingAccount/{id}). List or find SettlementAccount objects (GET /settlementAccount). Creates a SettlementAccount (POST /settlementAccount). Retrieves a SettlementAccount by ID (GET /settlementAccount/{id}). Updates partially a SettlementAccount (PATCH /settlementAccount/{id}). Deletes a SettlementAccount (DELETE /settlementAccount/{id}). List or find FinancialAccount objects (GET /financialAccount). Creates a FinancialAccount (POST /financialAccount). Retrieves a FinancialAccount by ID (GET /financialAccount/{id}). Updates partially a FinancialAccount (PATCH /financialAccount/{id}). Deletes a FinancialAccount (DELETE /financialAccount/{id}). List or find BillingCycleSpecification objects (GET /billingCycleSpecification). Creates a BillingCycleSpecification (POST /billingCycleSpecification). Retrieves a BillingCycleSpecification by ID (GET /billingCycleSpecification/{id}). Updates partially a BillingCycleSpecification (PATCH /billingCycleSpecification/{id}). Deletes a BillingCycleSpecification (DELETE /billingCycleSpecification/{id}). List or find BillFormat objects (GET /billFormat). Creates a BillFormat (POST /billFormat). Retrieves a BillFormat by ID (GET /billFormat/{id}). Updates partially a BillFormat (PATCH /billFormat/{id}). Deletes a BillFormat (DELETE /billFormat/{id}). List or find BillPresentationMedia objects (GET /billPresentationMedia). Creates a BillPresentationMedia (POST /billPresentationMedia). Retrieves a BillPresentationMedia by ID (GET /billPresentationMedia/{id}). Updates partially a BillPresentationMedia (PATCH /billPresentationMedia/{id}). Deletes a BillPresentationMedia (DELETE /billPresentationMedia/{id}). Register a listener (POST /hub). Unregister a listener (DELETE /hub/{id}). Client listener for entity PartyAccountAttributeValueChangeEvent (POST /listener/partyAccountAttributeValueChangeEvent). Client listener for entity PartyAccountStateChangeEvent (POST /listener/partyAccountStateChangeEvent). Client listener for entity BillingAccountAttributeValueChangeEvent (POST /listener/billingAccountAttributeValueChangeEvent). Client listener for entity BillingAccountStateChangeEvent (POST /listener/billingAccountStateChangeEvent). Client listener for entity SettlementAccountAttributeValueChangeEvent (POST /listener/settlementAccountAttributeValueChangeEvent). Client listener for entity SettlementAccountStateChangeEvent (POST /listener/settlementAccountStateChangeEvent). Client listener for entity FinancialAccountCreateEvent (POST /listener/financialAccountCreateEvent). Client listener for entity FinancialAccountAttributeValueChangeEvent (POST /listener/financialAccountAttributeValueChangeEvent). Client listener for entity FinancialAccountStateChangeEvent (POST /listener/financialAccountStateChangeEvent). Client listener for entity FinancialAccountDeleteEvent (POST /listener/financialAccountDeleteEvent).

Question 2

Which inputs does each call to the Account Management API need?

Accepted Answer

GET /partyAccount/{id}: requires id. PATCH /partyAccount/{id}: requires id. DELETE /partyAccount/{id}: requires id. GET /billingAccount/{id}: requires id. PATCH /billingAccount/{id}: requires id. DELETE /billingAccount/{id}: requires id. GET /settlementAccount/{id}: requires id. PATCH /settlementAccount/{id}: requires id. DELETE /settlementAccount/{id}: requires id. GET /financialAccount/{id}: requires id. PATCH /financialAccount/{id}: requires id. DELETE /financialAccount/{id}: requires id. GET /billingCycleSpecification/{id}: requires id. PATCH /billingCycleSpecification/{id}: requires id. DELETE /billingCycleSpecification/{id}: requires id. GET /billFormat/{id}: requires id. PATCH /billFormat/{id}: requires id. DELETE /billFormat/{id}: requires id. GET /billPresentationMedia/{id}: requires id. PATCH /billPresentationMedia/{id}: requires id. DELETE /billPresentationMedia/{id}: requires id. DELETE /hub/{id}: requires id. Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.

Question 3

Which errors can the Account Management API return?

Accepted Answer

400: Bad Request. 401: Unauthorized. 403: Forbidden. 404: Not Found. 405: Method Not allowed. 409: Conflict. 500: Internal Server Error. On 401, request a new access token and retry.

Question 4

Where is the Account Management API available?

Accepted Answer

Account Management is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.

Question 5

Which standard does the Account Management API follow?

Accepted Answer

It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.

Account Management API

What you can do with this API

Overview of Account Management API

Key Capabilities

1. Account Creation & Management

2. Billing on Behalf of (B2B2C)

3. Settlement & Financial Transactions (B2B)

4. Bill Item Creation & Query

5. Integration with Financial & CRM Systems

6. Compliance & Security

Use Cases of Account Management API

Questions about the Account Management API

Sample call

API reference