Start free trial

Add payment to invoice

POST/api/v1/invoices/{invoice_id}/payments

Link a bank transaction as payment against an invoice. Supports split payments (one transaction paying multiple invoices) and partial payments (multiple transactions paying one invoice).

Operation ID: create_invoice_payment_api_v1_invoices__invoice_id__payments_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_idstring · uuidrequired

Request body

Schema: InvoicePaymentRequest

transaction_idstringrequired

UUID of the bank transaction representing the payment.

amountintegerrequired

Payment amount in cents allocated to this invoice. Must be > 0 and <= the remaining unallocated amount on the transaction. Overpayments (exceeding the invoice balance) are permitted.

paid_onstring · date-time

Override payment date (ISO 8601). Defaults to the transaction datetime if omitted.

Responses

201Successful Response

Schema: SuccessEnvelope_InvoicePaymentResponse_

successboolean
messagestring
codestring
dataapp__api__v1__schemas__invoices__invoice__InvoicePaymentResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject