Billing APIs

16 min

The IoT.live Billing APIs provide programmatic access to invoice and billing-related information.

These APIs support:

Listing available invoice records

Exporting invoice datasets

Importing CDP invoice files

Integrating billing data with external reporting systems

[IMAGE PLACEHOLDER: Billing API overview]

Billing API overview

The Billing API group includes APIs for working with CDP invoice data.

Core Billing APIs include:

API	Purpose
listCdpInvoices	Search and list available invoice information
exportCdpInvoices	Export invoice information
importCdpInvoices	Import invoice files using a preset file format

listCdpInvoices API

The listCdpInvoices API returns a searchable and filterable list of available invoice information.

Typical use cases include:

Displaying invoice history

Building billing dashboards

Searching billing records

Supporting customer billing reviews

[IMAGE PLACEHOLDER: Invoice list API workflow]

Example listCdpInvoices request

POST https://naapi.iotm.mobi/ws/json/billing/listCdpInvoices Content-Type: application/json; charset=UTF-8 { "corrId": "billing-list-001", "username": "[email protected]", "password": "StrongPassword123!", "licenseKey": "9d48f951-e867-404a-a9b2-2b0c981ba02f" }

exportCdpInvoices API

The exportCdpInvoices API exports invoice information.

Typical use cases include:

Finance reporting

Customer billing exports

Offline analysis

Billing reconciliation

External system integration

[IMAGE PLACEHOLDER: Billing export workflow]

Example exportCdpInvoices request

POST https://naapi.iotm.mobi/ws/json/billing/exportCdpInvoices Content-Type: application/json; charset=UTF-8 { "corrId": "billing-export-001", "username": "[email protected]", "password": "StrongPassword123!", "licenseKey": "9d48f951-e867-404a-a9b2-2b0c981ba02f", "fileType": "csv" }

importCdpInvoices API

The importCdpInvoices API imports invoice files based on a preset file format.

Unlike most JSON APIs, this API uses:

multipart/form-data

File upload parameters

Form fields

CSV or ZIP file types

Supported file types include:

csv_text

[IMAGE PLACEHOLDER: Invoice import workflow]

Import fields

The invoice import workflow may include:

Field	Description
username	API username
password	API user password
licenseKey	Organisation API license key
file	Invoice file upload
fileType	File format, such as csv_text or zip
cdpName	CDP account name
cdpId	CDP account identifier
currency	Invoice currency

Example importCdpInvoices form fields

POST https://naapi.iotm.mobi/ws/json/billing/importCdpInvoices Content-Type: multipart/form-data username=[email protected] password=StrongPassword123! licenseKey=9d48f951-e867-404a-a9b2-2b0c981ba02f [email protected] fileType=csv_text cdpName=Example CDP currency=GBP

Billing export considerations

Billing exports may contain sensitive commercial information.

Recommended controls include:

Restricting billing API access

Securing downloaded files

Applying internal finance data policies

Avoiding unnecessary retention of exported billing data

Billing data may contain commercially sensitive customer, usage, and invoice information.

Common billing integration scenarios

Typical integrations include:

Finance reporting systems

Billing reconciliation tools

Customer invoice dashboards

Data warehouse imports

Internal cost analysis workflows

Best practices

Recommended practices include:

Use dedicated API users for billing integrations

Restrict billing permissions carefully

Log corrId values for traceability

Store exported invoice files securely

Validate imported invoice files before upload