/bff/invoice/send-reminder

Composes and queues a reminder email with the invoice PDF attached. Uses the organisation support email as From, the customer email as To, and respects a configurable cooldown window (default 72h) so admins don't accidentally spam the same client.

InvoicepostBffInvoiceSend-reminder

Parameters

4 body

4 total

Body · 4

idstringRequired

External invoice ID.

recipientEmailstring

Override the auto-resolved recipient (customer email). Useful when sending to an accountant or a billing contact instead of the primary email.

ignoreCooldownboolean

Send even if a reminder was already sent recently. Default false — UI should warn the user when overriding cooldown.

Default: false

cooldownHoursnumber

Override the default cooldown window between reminders. Default 72 (3 days).

Request

POST /bff/invoice/send-reminder

post

curl -X POST "https://api.bizkithub.com/bff/invoice/send-reminder" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "aB3xKm9pQ2wLn4Yz",
  "recipientEmail": "accountant@client.com",
  "ignoreCooldown": false,
  "cooldownHours": 0
}'

Response

JSON payload

{
  "sent": true,
  "recipient": "example_recipient",
  "reminderCount": 0,
  "sentAt": "example_sentAt",
  "emailExternalId": "example_emailExternalId"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key