HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner settlement report / Issue partner invoice

This action validates the given settlement report and accepts it for partner invoice generation. The settlement report must have a B2B invoice processor configured on the report's issuing operator. A cross-operator report — one issued by a service operator other than the partner's home operator, whose operatorId on the v1.1 settlement report differs from the partner's operator — is not yet eligible and is rejected with 422.

A settlement can hold money owed to the operator, money owed to the partner, or both. Each direction that holds money gets its own invoice:

  • Money owed to the operator produces a partner invoice. The operator is the seller.
  • Money owed to the partner produces a self-billing invoice. The partner is the seller and the invoice is issued in the partner's name.

When money is owed in both directions, two invoices are issued. A report that holds no money in either direction is refused with 422.

Invoices are generated asynchronously after the 202 response. expectedDocumentCount says how many to expect. Poll GET resources/partner-invoices/v1.0 filtered by settlementReportId until they appear.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The partner settlement report ID to which the action will be applied

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json