Collections API
Coordinate reminder queues and recovery actions through the Conduitt collections domain.
The collections API manages follow-up work after an invoice needs attention.
/v1/collections/remindersEndpoints
| Method | Path | Purpose |
|---|---|---|
GET | /v1/collections/reminders | list reminder work |
GET | /v1/collections/reminders/upcoming | check the actions scheduled next |
GET | /v1/collections/reminders/history | check delivery history |
GET | /v1/collections/reminders/invoice/{invoiceId} | check one invoice's reminder state |
POST | /v1/collections/reminders | schedule a reminder |
PATCH | /v1/collections/reminders/{id} | update a reminder |
DELETE | /v1/collections/reminders/{id} | cancel a reminder |
POST | /v1/collections/reminders/{id}/send | send a reviewed reminder now |
POST | /v1/collections/reminders/{id}/snooze | postpone reminder work |
POST | /v1/collections/reminders/bulk-send | send a reviewed group of reminders |
Use idempotency keys on write operations that a worker or operator can retry. Refresh the related invoice and reminder history after a successful mutation. Your interface then shows the committed collection state.
Reminder Request Schemas
| Operation | Needed fields | Optional fields and limits |
|---|---|---|
| create | invoiceId, future scheduledDate | type defaults to email; message max 2,000 characters |
| update | none | future scheduledDate, type, or message max 2,000 characters |
| snooze | future snoozeUntil | none |
| bulk send | invoiceIds | follow the documented array limit and per-invoice eligibility rules |
Reminder type is email, sms, or both. Only invoices in pending, unpaid, or overdue status are eligible.
Response Contracts
List, upcoming, and history responses include data plus offset-pagination meta. The upcoming response also includes the evaluated period. Single-invoice reminder detail includes scheduledAt and canSendReminder. Your client then does not need to recreate cooldown rules.
Send responses include success, invoiceId, invoiceNumber, and nullable sentAt. Bulk send returns sentCount and the exact invoices that got a reminder. Compare the result with the selection that you sent. Show the ineligible or skipped records.