Resources
Every dunning resource below is generated from the same OpenAPI spec documented in the API Reference — the CLI dispatches to the exact same endpoints, so filters, validation and delete behaviour are identical. Reach for schema introspection whenever a command's exact parameters aren't obvious from the examples here.
kobana dunning <resource> <method> [flags]
:::caution Routes that changed in October 2026
The pages below describe kobana-cli 0.7.0, whose copy of the spec predates the October 2026 change: in it, people bulk-archive create, charges bulk-archive create, tasks delete, negativations delete, protests delete and negotiation-campaigns delete call routes the API no longer has (now DELETE /v1/people/bulk, DELETE /v1/charges/bulk, PUT /v1/tasks/{id} with status: cancelled, POST /v1/negativations/{id}/remove, POST /v1/protests/{id}/cancel and POST /v1/negotiation-campaigns/{id}/end). Update the CLI once the release with the new spec is out.
:::
How to read these pages
--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference. See Authentication for the Régua de Cobrança credential.
The catalogue
| Resource | Command | Methods |
|---|---|---|
| Customers | people | list, create, get, update, delete, statement-pdf, bulk-archive create, contact-points list, contact-points create, contact-points update, contact-points delete |
| Classifications | classifications | list, create, get, update, delete |
| Charges | charges | list, create, get, update, delete, notify, settlement-pdf, bulk-archive create, bulk-assign-rule create, bulk-cancel create |
| Collection rules | collection-rules | list, create, get, update, delete, steps get, steps create, steps update, steps delete |
| Message templates | templates | list, create, get, update, delete, duplicate |
| Notifications | notifications | list, create, get, update, delete, resend |
| Notification channels | notification-channels | list, create, get, update, delete |
| Notification preferences | notification-preferences | list, update |
| E-mail layouts | email-layouts | list, create |
| Agreements | agreements | list, create, get, update, delete, accept, cancel, pdf, installments get, installments update |
| Negotiation campaigns | negotiation-campaigns | list, create, delete |
| Disputes | disputes | list, create, get, update |
| Credit-bureau reports | negativations | list, create, get, update, delete, remove |
| Protests | protests | list, create, get, update, delete, cancel |
| Interactions | interactions | list, create, get, update, delete |
| Tasks | tasks | list, create, get, update, delete, complete, bulk-assign create, bulk-complete create |
| Imports | imports | list, create, get |
| Exports | exports | charges list, jobs list, jobs create, jobs download, people list |
| Metrics | metrics | recovery list |
| Audit trail | audit-logs | list |
| Webhook endpoints | webhook-endpoints | list, create, get, update, delete, rotate-secret, test, deliveries retry, deliveries list |
| Token identity | me | list |
| Workspaces | workspaces | list |