VOvocal
Invoices

Record a payment on an invoice

Changed on

Records a payment entry on the invoice and marks it sent. Without markPaid, the invoice becomes paid only once its payments cover the total (like the app); a partial payment leaves it awaiting payment. Send markPaid: true or false to decide explicitly. A paid quote becomes a normal invoice.

post/invoices/{id}/record-payment

Request

Request body

amountnumber required

Not 0. Positive, except on a credit note (an invoice with a negative total): there the refund is negative, e.g. -120 for a credit note of -120.

datestring nullable

ISO 8601 date or date-time. Defaults to now; not in the future.

idstring nullable
markPaidboolean nullable

Omit to mark the invoice paid only once the payments cover its total (like the app); true/false to decide explicitly.

methodstring nullable

Alias of methodName.

methodIdstring nullable

Payment method id (GET /payment-methods).

methodNamestring nullable

Payment method name; created if missing.

Response

Payment recorded

Changes

  • d0319ad57804Revision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property