/bff/document/send-reminders-bulk

Sequential per-invoice reminder dispatch. Returns a summary plus a per-invoice row so the UI can show which invoices were sent, which were skipped (and why), and which errored.

InvoicepostBffDocumentSend-reminders-bulk

Parameters

JSON body

Request body

application/json

idsstring[]Required

List of external invoice IDs.

External invoice IDs to remind, in any order.

ignoreCooldownbooleanOptional

Ignore the per-invoice cooldown.

Default: false

cooldownHoursnumberOptional

Override the default cooldown window (hours).

Response schema

1 status code documented

200Success

sentnumberRequired

Number of reminders actually queued.

skippednumberRequired

Number of invoices skipped (paid, cancelled, cooldown, no recipient).

errorsnumberRequired

Number of invoices that threw an error.

rowsobject[]Required

Each array item:

idstringRequired

External invoice ID.

outcome"sent" | "skipped" | "error"Required

reasonstringOptional

Skip reason (when outcome is "skipped").

recipientstringOptional

Email recipient (when outcome is "sent").

errorstringOptional

Error message (when outcome is "error").

Response example

application/json

{
  "sent": 0,
  "skipped": 0,
  "errors": 0,
  "rows": [
    {
      "id": "example_id",
      "reason": "example_reason",
      "recipient": "example_recipient",
      "error": "example_error"
    }
  ]
}

Request example

POST /bff/document/send-reminders-bulk

post

curl -X POST "https://api.bizkithub.com/bff/document/send-reminders-bulk" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "ids": [
    "string"
  ],
  "ignoreCooldown": false,
  "cooldownHours": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key