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...
MTN TMF Customer Bill Management - TMF678 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include TM Forum, TMF678, Benin, South Sudan, and Eswatini. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
10 operations
across 8 paths,
organized into 4 resource areas,
and defines 32 schemas.
It is described by OpenAPI 2.0, at version 4.0.0.
Requests are made against the base URL https://api.mtn.com/tmf-api/customerBillManagement/v4.
10 operations8 paths32 schemas1 DELETE6 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Across 8 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 1 PATCH, 2 POST. They span 4 resource areas: customerBillOnDemand, customerBill, appliedCustomerBillingRate, events subscription. Each is listed below with its method, path, parameters, and response codes.
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CustomerBill (25 properties), AppliedCustomerBillingRate (18 properties), AttachmentRefOrValue (14 properties), Attachment (13 properties). Each schema is shown below with its type and property counts.
AccountBalance
object
Balances linked to the account
6 properties3 required
Any
AppliedBillingRateCharacteristic
object
An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others par…
6 properties2 required
AppliedBillingTaxRate
object
The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.
6 properties
AppliedCustomerBillingRate
object
A customer bill displays applied billing rates created before or during the billing process.
18 properties1 required
AppliedPayment
object
The applied payment is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill.
5 properties
Attachment
object
Complements the description of an element (for instance a product) through video, pictures...
13 properties
AttachmentRef
object
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
9 properties1 required
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
BillRef
object
Bill reference.
6 properties1 required
BillingAccountRef
object
Reference to the billing account in case of not billed item.
7 properties1 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties2 required
CustomerBill
object
The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according…
25 properties
CustomerBill_Update
object
The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according…
4 properties
CustomerBillOnDemand
object
This resource is used to manage the creation request of a customer bill in real-time (on demand).
12 properties
CustomerBillOnDemand_Create
object
This resource is used to manage the creation request of a customer bill in real-time (on demand). Skipped properties: id,href
10 properties
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties1 required
FinancialAccountRef
object
AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An accou…
8 properties1 required
Money
object
A base / value business entity used to represent money
2 properties
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
7 properties1 required
PaymentRef
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
7 properties1 required
ProductRef
object
7 properties1 required
Quantity
object
An amount in a given unit
2 properties
Reference
object
General Referencing Resource Schema
6 properties
RelatedPartyRef
object
RelatedParty reference. A related party defines party or party role linked to a specific entity.
8 properties1 required
StateValues
string
TaxItem
object
A tax item is created for each tax rate and tax type used in the bill.
6 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
stateValue
string
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties1 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of MTN TMF Customer Bill Management - TMF678, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
