Skip to main content

Record Supplier Payment

POST 
/api/purchase-invoices/supplier-payments

Record one supplier-level payment allocated across multiple open invoices. All-or-nothing: the run is rejected (422) if any allocation exceeds its invoice's outstanding balance, targets another supplier's invoice, or repeats an invoice.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Fields:

  • supplier_id (required)
  • payment_date (required, Y-m-d)
  • payment_type_id (optional; defaults to Cash)
  • external_reference (optional; stored on the payment run and suffixed per invoice on the individual payment records)
  • allocations (required, min 1): purchase_invoice_id + amount (> 0, at most the invoice's outstanding balance)

Each allocation creates a regular invoice payment, so invoice payment statuses (paid / partially paid) update immediately.

Authentication: Requires Bearer token.

Approval policy: While the bill-payment approval policy is enabled every allocation must fit its bill's approved remainder; otherwise nothing is recorded and the 422 lists every offending bill (code approval_required, or approval_pending when every offending bill is only awaiting approval).

Request​

Responses​

Created