Product
How to set reminder levels, run dunning, hold reminders and hand invoices over to collection.
Dunning raises overdue sales invoices through a series of reminder levels and, at the end, hands them to a collection agency. It sits next to the reminder emails that go out for single invoices. Those sends stay in the invoice reminder history. The page lives under Workspace, Finance, Dunning.
| Route | Purpose |
|---|---|
/{orgSlug}/dunning | Sets reminder levels, runs dunning and shows earlier runs. Needs invoice.readAll. |
A level has the number of days after the due date at which it applies, a template key, an optional text block key and a fee. Levels are numbered in order, each comes later than the one before, and only the last can be final. A member with the manage permission replaces the whole list.
A member with invoice.send starts a run. Every overdue invoice moves to the highest level it has reached. A run records the invoices it picked, grouped by customer, so you can see who was reminded and what balance and fee applied. Invoices with a pause that has not ended are skipped.
Select invoices in a run and enter a date to hold their reminders until then. This needs invoice.pauseReminders. Leaving the date empty resumes the reminders.
Select invoices and choose a collection agency, which is a customer record with the supplier role. A member with invoice.recordPayment hands the invoices over. Their dunning stops and the hand over is added to their history.
The same actions are available under /api/v1/organizations/{organizationId}/: dunning-levels, dunning-runs, dunning-runs/{runId}/items, invoice-collections, invoices/{invoiceId}/dunning-history and invoices/{invoiceId}/dunning-pause. Each operation lists its permission in the API reference.
Last updated on