Skip to main content
POST
Mark an invoice as settled outside the platform

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

customerId
string
required

The customer id

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Body

application/json
invoiceId
string
required

the invoice to mark as settled outside the platform

Pattern: ^invoice(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
manualPaymentMethod
enum<string>
required

how the payment was settled outside the platform

Available options:
check,
wire_transfer,
cash
appliedAt
string<date-time>
required

accounting application date of the settlement — drives paidAt / finalizedAt, cannot be in the future

Response

The response is of type object.