/bff/document/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.

InvoicepostBffDocumentSend-reminder

Parameters

JSON body

Request body

application/json

idstringRequired

External invoice ID.

ExampleaB3xKm9pQ2wLn4Yz

recipientEmailstringOptional

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

Exampleaccountant@client.com

ignoreCooldownbooleanOptional

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

Default: false

cooldownHoursnumberOptional

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

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

sent"true"Required

recipientstringRequired

Email address the reminder was sent to.

reminderCountnumberRequired

Total number of reminders sent for this invoice (after this one).

sentAtstringRequired

ISO timestamp when the reminder was queued.

emailExternalIdstringRequired

External ID of the queued email message.

Variant 2

sent"false"Required

skippedReason"paid" | "cooldown" | "no-recipient" | "cancelled"Required

paid/cancelled — invoice no longer needs reminding. cooldown — last reminder was too recent. no-recipient — no email found on customer/recipient.

lastReminderAtstringOptional

ISO timestamp of the previous reminder (only when reason is cooldown).

Response example

application/json

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

Request example

POST /bff/document/send-reminder

post

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key