Skip to main content
POST
Mark invoice as paid

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
invoiceRef
string
required

The billing provider (Received) invoice ID

Maximum string length: 255

Body

application/json

Input for marking an invoice as paid.

paidDate
string<date-time>

When the invoice was paid. Defaults to now

Response

The outcome of the reconciliation.

Response object

data
MarkInvoicePaidResponse · object
required

The outcome of marking an invoice as paid.