Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TM Forum billFormat API

The billFormat API from TM Forum — 2 operation(s) for billformat.

TM Forum billFormat API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include billFormat. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

billFormat 5
GET
/billFormat
List or find BillFormat objects
listBillFormat 3 params → 200400401403404405409500
POST
/billFormat
Creates a BillFormat
createBillFormat 1 param → 201400401403405409500
GET
/billFormat/{id}
Retrieves a BillFormat by ID
retrieveBillFormat 2 params → 200400401403404405409500
PATCH
/billFormat/{id}
Updates partially a BillFormat
patchBillFormat 2 params → 200400401403404405409500
DELETE
/billFormat/{id}
Deletes a BillFormat
deleteBillFormat 1 param → 204400401403404405409500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (8 properties), BillFormat (7 properties), BillFormat_Create (5 properties), BillFormat_Update (5 properties). Each schema is shown below with its type and property counts.

Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
BillFormat_Update
object
A detailed description of the way in which a bill is presented. Skipped properties: id,href
5 properties 1 required
BillFormat
object
A detailed description of the way in which a bill is presented.
7 properties 1 required
BillFormat_Create
object
A detailed description of the way in which a bill is presented. Skipped properties: id,href
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-billformat-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
TM Forum financialAccount API