billing-api

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

Billing API

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

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.

Before you start

Review the shared API docs before you work with billing resources.

• Authentication
• URL structure
• Error handling

Core resources

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 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 . A journal is generated by vendors using 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.

Browse 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.

Use the following links to jump to the collection you need:

• Credit Memo
• Custom Ledgers
• Invoices
• Journals
• Journal Charges
• Journal Attachments
• Ledgers
• Overrides
• Statements

Credit Memo

View Credit Memo operations

Operation	Method	Description	Access
Create credit memo	POST	Create a credit memo.
List credit memos	GET	Retrieves the credit memo collection.	client, ops
Get credit memo	GET	Retrieves a credit memo by ID.	client, ops
Update credit memo	PUT	Updates properties of a credit memo.	client, ops
Create credit memo attachment	POST	Creates a credit memo attachement.
List credit memo attachments	GET	Retrieves the list of attachments for a credit memo.	client, ops
Get credit memo attachment	GET	Retrieves a specific credit memo attachment by ID.	client, ops
Update credit memo attachment	PUT	Updates a credit memo attachement.	client, ops
Delete credit memo attachment		Deletes a credit memo attachment	client, ops

Custom Ledgers

View Custom Ledgers operations

Operation	Method	Description	Access
Create custom ledger	POST	Creates a custom ledger	ops
List custom ledgers	GET	Retrieves the custom ledgers collection	ops
Get custom ledger	GET	Retrieves a custom ledger by ID	ops
Update custom ledger	PUT	Updates properties of a custom ledger	ops
Delete custom ledger	DELETE	Deletes a custom ledger	ops
Upload charges	POST	Uploads a file with charges; validation starts automatically	ops
Accept custom ledger	POST	Transitions custom ledger to Accepted status, finalizing charges and generating statements.	ops
List custom ledger charges	GET	Returns list of all charges for the custom ledger.	ops
Get custom ledger charge	GET	Returns a specific charge by ID that exists in the custom ledger.	ops
Create custom ledger attachment	POST	Creates a custom ledger attachment, uploading a file.	ops
List custom ledger attachments	GET	Retrieves the list of attachments for the custom ledger.	ops
Get custom ledger attachment	GET	Retrieves a specific custom ledger attachment by ID.	ops
Delete custom ledger attachment	DELETE	Deletes a custom ledger attachment.	ops

Invoices

View Invoices operations

Operation	Method	Description	Access
List invoices	GET	Retrieves the invoices collection.	client, ops
Get invoice	GET	Retrieves an invoice by ID.	client, ops
Update invoice	PUT	Updates properties of an invoice.	client, ops
Create invoice attachment	POST	Create an invoice attachment.
List invoice attachments	GET	Retrieves the list of attachments for an invoice.	client, ops
Get invoice attachment	GET	Retrieves a specific invoice attachment by ID.	client, ops
Delete invoice attachment	DELETE	Deletes an invoice attachment.
List of Invoice lines	GET	Returns a list of all invoice lines for the invoice.	client, ops
Get an invoice line	GET	Returns a specific invoice line by ID that exists in the invoice.	client, ops

Journals

View Journals operations

Operation	Method	Description	Access
Create journal	POST	Creates a journal.	vendor
List journals	GET	Retrieves the journals collection.	vendor, ops
Get journal	GET	Retrieves a journal by ID.	vendor, ops
Update journal	PUT	Updates properties of a journal.	vendor, ops
Delete journal	DELETE	Deletes a journal; vendor can delete before submission.	vendor
Upload journal charges	POST	Uploads a file with journal charges; validation starts automatically.	vendor
Submit journal	POST	Submits a journal for SWO review; moves status to Review.	vendor
Regenerate journal	POST	Regenerates a journal while in Review status.	ops
Enquire journal	POST	Moves journal to Inquiring status while in Review.	ops
Accept journal	POST	Moves journal to Accepted status while in Review.	ops
Complete journal	POST	Moves journal to Completed status.	ops
Get journal sellers	GET	Retrieves distinct sellers derived from journal charges.	vendor, ops

Journal Charges

View Journal Charges operations

Operation	Method	Description	Access
List journal charges	GET	Returns list of all charges for the journal.	vendor, ops
Get journal charge	GET	Returns a specific charge by ID that exists in the journal.	vendor, ops

Journal Attachments

View Journal Attachments operations

Operation	Method	Description	Access
Create journal attachment	POST	Creates a journal attachment, uploading a file or specifying an external link.	vendor
List journal attachments	GET	Retrieves the list of attachments for the journal.	vendor, ops
Get journal attachment	GET	Retrieves a specific journal attachment by ID.	vendor, ops
Delete journal attachment	DELETE	Deletes a journal attachment.	vendor

Ledgers

View Ledgers operations

Operation	Method	Description	Access
List ledgers	GET	Retrieves the ledgers collection.	ops
Get ledger	GET	Retrieves a ledger by ID.	ops
Update ledger	PUT	Updates properties of a ledger.	ops
Recalculate ledger	POST	Recalculates a ledger.	ops
Accept ledger	POST	Accepts a ledger.	ops
List ledger charges	GET	Returns list of all charges for the ledger.	ops
Get ledger charge	GET	Returns a specific charge by ID that exists in the ledger.	ops
Create ledger attachment	POST	Creates a ledger attachment.	ops
List ledger attachments	GET	Retrieves the list of attachments for a ledger.	ops
Get ledger attachment	GET	Retrieves a specific ledger attachment by ID.	ops
Update ledger attachment	PUT	Updates a ledger attachment.	ops
Delete ledger attachment	DELETE	Deletes a specific ledger attachment by ID.	ops

Overrides

View Overrides operations

Operation	Method	Description	Access
Create override	POST	Creates an override.	ops
List overrides	GET	Retrieves the overrides collection.	ops
Get override	GET	Retrieves an override by ID.	ops
Update override	PUT	Updates properties of an override.	ops
Disable override	POST	Disables an override.	ops
Enable override	POST	Enables a previously disabled override.	ops

Statements

View Statements operations

Operation	Method	Description	Access
List statements	GET	Retrieves the statements collection.	client, ops
Get statement	GET	Retrieves a statement by ID.	client, ops
Retry statement	POST	Retries sending a statement to the ERP system.	ops
Recalculate statement	POST	Recalculates a statement.	ops
Cancel statement	POST	Cancels a statement.	ops
List statement charges	GET	Returns list of all charges for the statement.	client, ops
Get statement charge	GET	Returns a specific charge by ID that exists in the statement	client, ops
Create statement attachment	POST	Create a statement attachment.
Get statement attachment	GET	Retrieves a statement attachment by ID.
Update statement attachment	PUT	Update a statement attachment.
Delete statement attachment	DELETE	Delete a statement attachment by ID.