Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Invoice
Admin

Record a payment or pre-issue credit against an invoice. payment_method=manual_bank_transfer requires ISSUED (records received funds); issue_credit allowed on DRAFT or ISSUED (write-off / pre-issue discount, requires `notes`). Idempotent on (invoice_id, external_reference).

Record a payment or pre-issue credit against an invoice. payment_method=manual_bank_transfer requires ISSUED (records received funds); issue_credit allowed on DRAFT or ISSUED (write-off / pre-issue discount, requires notes). Idempotent on (invoice_id, external_reference).

post/api/v1/admin/invoices/{invoiceId}/payments

Path parameters

invoiceIdstring uuid required

The invoiceId parameter

Request body

amountstring required

Payment amount in the invoice currency

currencystring required

Must match the invoice currency

external_referencestring nullable

Bank statement reference; idempotency key per (invoice_id, external_reference)

paid_atstring date-time required

When the funds actually moved

notesstring nullable

Required when payment_method=issue_credit (the reason)

Example request

{
  "amount": "1234.56",
  "currency": "GBP"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "invoice_number": "INV-202605-000001",
    "payment_reference": "QK7L2M9X4P0R",
    "currency": "GBP",
    "total_amount": "1234.56",
    "amount_paid": "0.00",
    "outstanding_amount": "1234.56",
    "transaction_count": 42,
    "payments": [
      {
        "amount": "125.00",
        "currency": "GBP"
      }
    ],
    "fx_rates": [
      {
        "source_currency": "GBP",
        "rate": "0.85120000",
        "provider": "openexchangerates"
      }
    ]
  }
}