Skip to main content

​
List collections

GET /collections · requires collection (view)
​
tab
string
default:"overdue"
overdue | soon | all
​
page
integer
default:"1"
​
pageSize
integer
default:"20"
Max 200.
​
subjectId
string

​
Preview a reminder

GET /collections/preview · requires collection (view)
​
contractId
string
required
​
paymentId
string
required
​
channelId
string
Defaults to the tenant’s default channel.
Renders what a reminder would contain without sending it.

​
Send a reminder

POST /collections/remind · requires collection (edit)
​
contractId
string
required
​
paymentId
string
required
​
channelId
string

​
Send reminders in bulk

POST /collections/remind-bulk · requires collection (edit)
​
channelId
string
​
tab
string
default:"overdue"
overdue | soon | all
​
subjectId
string
Sends a reminder for every payment matching the given tab (and subject, if provided).

​
Run due reminders now

POST /collections/run-due-reminders · requires collection (edit) No body. Triggers the same reminder sweep that runs on a schedule, on demand — useful after changing notification channel configuration and wanting to confirm it immediately, rather than waiting for the next scheduled run. See Tenant Administration for configuring notification channels, and Collections for the product-level walkthrough.