Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Invoice payments

Updates an invoice payment

Replaces the amount, date, and cash account on an existing uncleared invoice payment. Only uncleared payments can be updated; cleared or reconciled payments are rejected. This is a full-replace operation (PUT semantics) — include all fields in the request body.

put/invoices/{invoice_id}/payments/{payment_id}

Path parameters

invoice_idstring uuid required

UUID of the invoice to be used in this operation.

payment_idstring uuid required

UUID of the payment to be used in this operation.

Request body

datestring date required
account_codestring required

The account code found in the Chart of Accounts

Example request

{
  "amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "account_code": "11112"
}

Response

OK

idstring uuid required
status'SUCCESSFUL' | 'FAILED' | 'UNCLEARED' required
invoice_idstring uuid required
datestring date
account_codestring

The account code found in the Chart of Accounts

updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

Example response

{
  "amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "account_code": "11112"
}