POST
Record invoice payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_id
string<uuid>
required

Invoice ID

Body

application/json

Manual payment details to apply to the invoice balance.

Request payload for record payment.

amount
string
required

Money as a decimal string (minor units internally); validated > 0 in the service.

Example:

"1500000"

method
enum<string>
required

Payment method used for the payment.

Available options:
cash,
bank_transfer,
other
payment_date
string<date>
required

Date when the payment was received or recorded.

note
string | null

Optional note captured by the operator.

Maximum string length: 1000

Response

Recorded payment

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.