Update payment on invoice

PATCH/api/v1/invoices/{invoice_id}/payments/{payment_id}

Edit the amount or date of an existing payment record.

Operation ID: update_invoice_payment_api_v1_invoices__invoice_id__payments__payment_id__patch·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
payment_idstring · uuidrequired

Request body

amountinteger

New payment amount in cents. Must be > 0 and <= the remaining unallocated amount on the transaction (excluding the current payment's allocation).

paid_onstring · date-time

Override payment date (ISO 8601).

Responses

200Successful Response

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

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