Invoicing

Record a received payment against an invoice

Posts the payment through the canonical posting path and updates the invoice balance. Pass Idempotency-Key to retry safely.

post/invoices/{id}/pay

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/invoices/{id}/pay
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

idstring uuid required

Invoice UUID

Headers

Idempotency-Keystring

Stable retry key for this posting request within the LedgerHQ organization.

Request body

amountinteger required

Integer cents

datestring date required
method'bank_transfer' | 'cash' | 'check' | 'card' | 'other'
referencestring nullable
bankAccountIdstring uuid nullable

Response

Updated invoice and created payment

Changes

No recorded changes to this operation across all 5 revisions of this API.