Send a payment reminder for a contract invoice

POST/api/v1/contracts/invoices/{invoice_id}/reminder

Email the invoice's customer a payment reminder (amount due, due date, pay link when available). Only open or partially paid contract invoices qualify, and at most one reminder is sent per invoice per 24 hours.

Operation ID: send_invoice_reminder_api_v1_contracts_invoices__invoice_id__reminder_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_idstringrequired

Responses

201Successful Response

Schema: SuccessEnvelope_InvoiceReminderResponse_

successboolean
messagestring
codestring
dataInvoiceReminderResponse

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

Code samples

POST/api/v1/contracts/invoices/{invoice_id}/reminder

bash

curl -X POST 'https://api.ondayzero.com/api/v1/contracts/invoices/{invoice_id}/reminder' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'