Cobranças

Os títulos a receber de cada cliente — o que a régua persegue. notify dispara uma notificação manual fora da régua, settlement-pdf gera a carta de quitação (só para cobranças pagas), e os comandos bulk-* arquivam, cancelam ou aplicam uma régua a até 100 cobranças por chamada.

Comando	HTTP	Descrição
charges list	GET /v1/charges	Listar cobranças
charges create	POST /v1/charges	Criar cobrança
charges get	GET /v1/charges/{id}	Consultar cobrança
charges update	PUT /v1/charges/{id}	Atualizar cobrança
charges delete	DELETE /v1/charges/{id}	Excluir cobrança
charges notify	POST /v1/charges/{id}/notify	Notificar cobrança
charges settlement-pdf	GET /v1/charges/{id}/settlement-pdf	Carta de quitação (PDF)
charges bulk-archive create	POST /v1/charges/bulk-archive	Arquivar cobranças em massa
charges bulk-assign-rule create	POST /v1/charges/bulk-assign-rule	Aplicar régua em massa
charges bulk-cancel create	POST /v1/charges/bulk-cancel	Cancelar cobranças em massa

Exemplos

--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.

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

# Criar cobrança
kobana dunning charges create \
  --json '{"person_id": "PERSON_ID", "original_amount": 1500, "issue_date": "2026-07-01", "due_date": "2026-08-01"}'

# Notificar manualmente por e-mail
kobana dunning charges notify \
  --params '{"id": "CHARGE_ID"}' \
  --json '{"channel": "email", "recipient": "maria@exemplo.com.br", "subject": "Lembrete", "body": "Sua cobrança vence amanhã."}'

# Carta de quitação em PDF
kobana dunning charges settlement-pdf --params '{"id": "CHARGE_ID"}' --output quitacao.pdf

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

# Cancelar cobranças em massa
kobana dunning charges bulk-cancel create \
  --json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"]}' --dry-run

Próximos passos

• Réguas de cobrança
• Introspecção de schema — todos os parâmetros que este recurso aceita.