Recursos
Todo recurso de dunning abaixo é gerado a partir da mesma spec OpenAPI documentada na Referência da API — o CLI chama exatamente os mesmos endpoints, então filtros, validação e comportamento de exclusão são idênticos. Recorra à introspecção de schema sempre que os parâmetros exatos de um comando não estiverem óbvios nos exemplos destas páginas.
kobana dunning <recurso> <metodo> [flags]
:::caution Rotas que mudaram em outubro de 2026
As páginas abaixo descrevem o kobana-cli 0.7.0, cuja cópia da spec é anterior à mudança de outubro de 2026: nele, people bulk-archive create, charges bulk-archive create, tasks delete, negativations delete, protests delete e negotiation-campaigns delete chamam rotas que a API não tem mais (agora DELETE /v1/people/bulk, DELETE /v1/charges/bulk, PUT /v1/tasks/{id} com status: cancelled, POST /v1/negativations/{id}/remove, POST /v1/protests/{id}/cancel e POST /v1/negotiation-campaigns/{id}/end). Atualize o CLI quando a versão com a spec nova sair.
:::
Como ler estas páginas
--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa. Veja Autenticação para a credencial da Régua de Cobrança.
O catálogo
| Recurso | Comando | Métodos |
|---|---|---|
| Clientes | people | list, create, get, update, delete, statement-pdf, bulk-archive create, contact-points list, contact-points create, contact-points update, contact-points delete |
| Classificações | classifications | list, create, get, update, delete |
| Cobranças | charges | list, create, get, update, delete, notify, settlement-pdf, bulk-archive create, bulk-assign-rule create, bulk-cancel create |
| Réguas de cobrança | collection-rules | list, create, get, update, delete, steps get, steps create, steps update, steps delete |
| Modelos de mensagem | templates | list, create, get, update, delete, duplicate |
| Notificações | notifications | list, create, get, update, delete, resend |
| Canais de notificação | notification-channels | list, create, get, update, delete |
| Preferências de notificação | notification-preferences | list, update |
| Layouts de e-mail | email-layouts | list, create |
| Acordos | agreements | list, create, get, update, delete, accept, cancel, pdf, installments get, installments update |
| Campanhas de negociação | negotiation-campaigns | list, create, delete |
| Disputas | disputes | list, create, get, update |
| Negativações | negativations | list, create, get, update, delete, remove |
| Protestos | protests | list, create, get, update, delete, cancel |
| Interações | interactions | list, create, get, update, delete |
| Tarefas | tasks | list, create, get, update, delete, complete, bulk-assign create, bulk-complete create |
| Importações | imports | list, create, get |
| Exportações | exports | charges list, jobs list, jobs create, jobs download, people list |
| Métricas | metrics | recovery list |
| Trilha de auditoria | audit-logs | list |
| Endpoints de webhook | webhook-endpoints | list, create, get, update, delete, rotate-secret, test, deliveries retry, deliveries list |
| Identidade do token | me | list |
| Workspaces | workspaces | list |