Send payment reminders in bulk

POST/api/v1/contracts/invoices/reminders

Send payment-reminder emails for up to 100 contract invoices in one call. Applies the single-reminder rules per invoice (open/partially paid only, customer email required, 24h cooldown) and returns a per-invoice sent/skipped result instead of failing the whole batch.

Operation ID: send_invoice_reminders_batch_api_v1_contracts_invoices_reminders_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.

Request body

Schema: InvoiceReminderBatchRequest

invoice_idsarray · stringrequired: Contract-invoice IDs to remind (deduplicated per request).

Responses

201Successful Response

Schema: SuccessEnvelope_InvoiceReminderBatchResponse_

successboolean
messagestring
codestring
dataInvoiceReminderBatchResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error - Invalid data format

Code samples

POST/api/v1/contracts/invoices/reminders

bash

curl -X POST 'https://api.ondayzero.com/api/v1/contracts/invoices/reminders' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "invoice_ids": []
}'