Billing API

Use the Billing API to manage invoices, journals, and other billing operations programmatically.

The Billing API allows you to interact with the billing features of the Marketplace Platform programmatically. The API centralizes billing workflow, allowing you to fully automate your financial operations.

With this API, you can create, update, retrieve, and manage financial documents through secure endpoints. The documents include invoices, credit memos, statements, journals, and custom ledgers. The API also includes endpoints for managing journal and invoice attachments.

Try APIDownload API

Core Concepts

The Billing API is built around the following core resources:

• Credit memo - Represents credit memos within the ERP system.

• Custom ledger - Represents a ledger generated by the rating function within the context of a specific seller. Each ledger is derived from the corresponding entries recorded in the journal.

• Invoice - Represents an invoice created in the ERP system.

• Invoice line - Represents a record of invoice generated in the ERP system.

• Journal - Represents the journal object, associated with the authorization and is generated by vendors using the raw data obtained from their services.

• Journal charge - Represents individual charges within a journal.

• Journal attachment - Represents files attached to journals.

• Override - Makes a client eligible for manual billing, bypassing the automated billing process. Assigning an override indicates that the client’s billing requires flexibility and will be processed manually.

• Statement - Represents billing entries generated within the context of a specific agreement, based on the corresponding ledger.

Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Credit Memo

Capability	Client	Vendor	Operations
List credit memo lines	✅	❌	✅
Get credit memo line	✅	❌	✅
List credit memo attachments	✅	❌	✅
Get credit memo attachment	✅	❌	✅

Custom Ledgers

Capability	Client	Vendor	Operations
List custom ledgers	❌	❌	✅
Get custom ledger	❌	❌	✅
Create custom ledger	❌	❌	✅
Update custom ledger	❌	❌	✅
Delete custom ledger	❌	❌	✅
Upload charges for custom ledger	❌	❌	✅
Submit custom ledger	❌	❌	✅
List custom ledger charges	❌	❌	✅
Get custom ledger charge	❌	❌	✅
Get a file with custom ledger charges	❌	❌	✅
List custom ledger attachments	❌	❌	✅
Get custom ledger attachment	❌	❌	✅
Create custom ledger attachment	❌	❌	✅
Delete custom ledger attachment	❌	❌	✅

Invoice

Capability	Client	Vendor	Operations
List invoices	✅	❌	✅
Get invoice	✅	❌	✅
Update invoice	✅	❌	✅
List invoice lines	✅	❌	✅
Get invoice line	✅	❌	✅
List invoice attachments	✅	❌	✅
Get invoice attachment	✅	❌	✅

Journal

Capability	Client	Vendor	Operations
List journals	❌	✅	✅
Get journal	❌	✅	✅
Create journal	❌	✅	❌
Delete journal	❌	✅	❌
Update journal	❌	✅	✅
Upload journal charges	❌	✅	❌
Submit journal	❌	✅	❌
Regenerate journal	❌	❌	✅
Inquire journal	❌	❌	✅
Accept journal	❌	❌	✅
Complete journal	❌	❌	✅
Get sellers for a journal	❌	✅	✅

Journal Charges

Capability	Client	Vendor	Operations
List journal charges	❌	✅	✅
Get journal charge	❌	✅	✅
Get a file with journal charges	❌	✅	✅

Journal Attachments

Capability	Client	Vendor	Operations
List journal attachments	❌	✅	✅
Get journal attachment	❌	✅	✅
Create journal attachment	❌	✅	❌
Delete journal attachment	❌	✅	❌

Ledgers

Capability	Client	Vendor	Operations
List ledgers	❌	❌	✅
Get ledger	❌	❌	✅
Update ledger	❌	❌	✅
Regenerate ledger	❌	❌	✅
Accept ledger	❌	❌	✅
List ledger charges	❌	❌	✅
Get ledger charge	❌	❌	✅
Get a file with ledger charges	❌	❌	✅
List ledger attachments	❌	❌	✅
Get ledger attachment	❌	❌	✅

Overrides

Capability	Client	Vendor	Operations
List overrides	❌	❌	✅
Get override	❌	❌	✅
Create override	❌	❌	✅
Update override	❌	❌	✅
Disable override	❌	❌	✅
Enable override	❌	❌	✅

Statement

Capability	Client	Vendor	Operations
List statements	✅	❌	✅
Get statement	✅	❌	✅
Retry sending a statement to ERP	❌	❌	✅
Regenerate statement	❌	❌	✅
Cancel statement	❌	❌	✅
List statement charges	✅	❌	✅
Get statement charge	✅	❌	✅