201Successful Response
Schema: SuccessEnvelope_BulkMarkInvoicesPaidResponse_
successbooleanmessagestringcodestringdataBulkMarkInvoicesPaidResponse
/api/v1/invoices/bulk-paymentsMark a selection of invoices paid in one call, recording the payment date you supply and optionally matching one or more bank transactions to each invoice.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: BulkMarkInvoicesPaidRequest
invoicesarray · BulkInvoicePaymentRowrequiredBulkInvoicePaymentRowInvoices to settle (1-500 rows).
invoice_idstringrequiredUUID of the invoice to settle.
paid_onstring · date-timePayment date for this invoice (YYYY-MM-DD or full ISO 8601). Overrides the batch-level paid_on. When transactions are linked and no date is given anywhere, the transaction's own date is recorded.
transactionsarray · BulkInvoicePaymentAllocationBank transactions to match to this invoice. One or many — a customer who paid an invoice in two deposits gets two entries. Leave empty to mark the invoice paid without linking a transaction.
paid_onstring · date-timePayment date applied to every row that does not carry its own (YYYY-MM-DD or full ISO 8601). This is the date recorded as the invoice's 'Paid on' — not the date the request was made.
Schema: SuccessEnvelope_BulkMarkInvoicesPaidResponse_
successbooleanmessagestringcodestringdataBulkMarkInvoicesPaidResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.