Cobros
Los títulos por cobrar de cada cliente — lo que persigue la regla. notify dispara una notificación manual fuera de la regla, settlement-pdf genera la carta de finiquito (solo para cobros pagados), y los comandos bulk-* archivan, cancelan o aplican una regla a hasta 100 cobros por llamada.
| Comando | HTTP | Descripción |
|---|---|---|
charges list | GET /v1/charges | Listar cobros |
charges create | POST /v1/charges | Crear cobro |
charges get | GET /v1/charges/{id} | Consultar cobro |
charges update | PUT /v1/charges/{id} | Actualizar cobro |
charges delete | DELETE /v1/charges/{id} | Eliminar cobro |
charges notify | POST /v1/charges/{id}/notify | Notificar cobro |
charges settlement-pdf | GET /v1/charges/{id}/settlement-pdf | Carta de finiquito (PDF) |
charges bulk-archive create | POST /v1/charges/bulk-archive | Archivar cobros en masa |
charges bulk-assign-rule create | POST /v1/charges/bulk-assign-rule | Aplicar regla en masa |
charges bulk-cancel create | POST /v1/charges/bulk-cancel | Cancelar cobros en masa |
Ejemplos
--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.
# Cobros vencidos
kobana dunning charges list \
--params '{"status": "overdue", "per_page": 100}' \
--fields "id,person_id,document_number,current_amount,due_date"
# Crear cobro
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 finiquito en PDF
kobana dunning charges settlement-pdf --params '{"id": "CHARGE_ID"}' --output quitacao.pdf
# Aplicar una regla a varios cobros
kobana dunning charges bulk-assign-rule create \
--json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"], "collection_rule_id": "RULE_ID"}'
# Cancelar cobros en masa
kobana dunning charges bulk-cancel create \
--json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"]}' --dry-run
Próximos pasos
- Reglas de cobranza
- Introspección de schema — todos los parámetros que acepta este recurso.