Uso

Sintaxe

kobana <produto> <recurso> <metodo> [flags]

• <produto> — banking, finance, billing, inbox, dunning ou dashboards.
• <recurso> — pode ser aninhado: charges, agreements installments, collection-rules steps.
• <metodo> — a ação: list, get, create, update, delete, ou uma ação específica do recurso.

A versão da API nunca entra no comando — o CLI resolve a URL a partir da spec OpenAPI embutida.

Parâmetros de URL e de query vão em --params; o corpo da requisição vai em --json. As listagens paginam por page/per_page (máximo de 100 por página), então --page-all percorre todas as páginas sozinho.

Toda a superfície é descoberta pelo --help, em qualquer nível:

kobana --help                          # produtos
kobana dunning --help                  # recursos da Régua de Cobrança
kobana dunning collection-rules --help # métodos de um recurso

Recursos de dunning

Recurso	Descrição
people	Clientes
classifications	Classificações
charges	Cobranças
collection-rules	Réguas de cobrança
templates	Modelos de mensagem
notifications	Notificações
notification-channels	Canais de notificação
notification-preferences	Preferências de notificação
email-layouts	Layouts de e-mail
agreements	Acordos
negotiation-campaigns	Campanhas de negociação
disputes	Disputas
negativations	Negativações
protests	Protestos
interactions	Interações
tasks	Tarefas
imports	Importações
exports	Exportações
metrics	Métricas
audit-logs	Trilha de auditoria
webhook-endpoints	Endpoints de webhook
me	Identidade do token

Cada recurso tem a sua própria página, com a tabela completa de comandos e exemplos — veja o catálogo.

Exemplos

# Cobranças vencidas de um cliente
kobana dunning charges list \
  --params '{"person_id": "PERSON_ID", "status": "overdue"}' \
  --fields "id,document_number,current_amount,due_date"

# Criar um cliente e uma cobrança
kobana dunning people create --json '{"name": "Maria da Silva", "document_type": "cpf", "document_number": "12345678901"}'
kobana dunning charges create \
  --json '{"person_id": "PERSON_ID", "original_amount": 1500, "issue_date": "2026-07-01", "due_date": "2026-08-01"}'

# Aplicar uma régua a várias cobranças
kobana dunning charges bulk-assign-rule create --dry-run \
  --json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"], "collection_rule_id": "RULE_ID"}'

# Aceitar um acordo e ver as parcelas
kobana dunning agreements accept --dry-run --params '{"id": "AGREEMENT_ID"}'
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'

# Listar com paginação automática (NDJSON)
kobana dunning people list --page-all --fields "id,name,document_number"

# Saída em tabela
kobana dunning collection-rules list --output-format table

# Salvar a resposta em arquivo
kobana dunning people statement-pdf --params '{"id": "PERSON_ID"}' --output extrato.pdf

Próximos passos

• Introspecção de schema — inspecione parâmetros e corpo de qualquer endpoint.
• Flags globais — todas as flags que um comando aceita.
• Helpers — atalhos +verbo para fluxos comuns.
• Recursos — o catálogo completo, recurso a recurso.