201Successful Response
Schema: SuccessEnvelope_BillBatchPaymentResponse_
successbooleanmessagestringcodestringdataBillBatchPaymentResponse
/api/v1/bills/payments/batchApply a single bank transaction to multiple bills and/or direct expense lines in one atomic request. Validates the total allocation against the transaction's remaining unallocated balance before creating any payments.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: BillBatchPaymentRequest
transaction_idstringrequiredUUID of the bank transaction representing the payment.
allocationsarray · BillBatchPaymentAllocationBillBatchPaymentAllocationBill slices (0+). Each bill_id must be unique.
bill_idstringrequiredUUID of the bill receiving this slice of the transaction.
amountintegerrequiredAmount in cents to allocate to this bill. Must be > 0.
expense_linesarray · BillBatchExpenseLineBillBatchExpenseLineOptional expense lines for any remaining balance. Each line debits an expense ledger on the transaction's journal entry.
ledger_idstringrequiredUUID of the expense ledger account to debit.
amountintegerrequiredAmount in cents to categorize as expense. Must be > 0.
descriptionstringOptional memo stored on the journal-entry line.
paid_onstring · date-timeOverride payment date applied to every allocation. Defaults to the transaction datetime if omitted.
override_holdbooleanRecord the payment even though an allocated bill is on payment hold. Requires override_reason; both are written to the audit log.
override_reasonstringWhy a held bill is being paid anyway (required with override_hold).
Schema: SuccessEnvelope_BillBatchPaymentResponse_
successbooleanmessagestringcodestringdataBillBatchPaymentResponseSchema: 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.
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.