Create a settlement invoice for an advance invoice

Create a settlement invoice linked to an existing advance invoice.

A settlement invoice finalizes the billing cycle started by an advance invoice.
It references the advance invoice and may include additional transactions
that were not part of the original advance.

Validation Rules:

  • The parent document must be an ADVANCE_INVOICE
  • The parent document must be in an active status
  • There must not already be an active settlement invoice for this advance
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

The ID of the advance invoice to settle

Body Params
int64
required
≥ 0
transactionIds
array of int64s
deprecated

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

transactionIds
folioIds
array of int64s

Include all transactions from the specified folio IDs

folioIds
excludeTransactionIds
array of int64s

Exclude transactions with the specified IDs

excludeTransactionIds
includeTransactionIds
array of int64s

Include transactions with the specified IDs

includeTransactionIds
transactionIdToAmount
object | null

Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion

recipient
object
manualRecipient
object
int64 | null
≥ 1
date
string | null
Headers
int64
required
≥ 1

Property id

Response

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