Reglas de cobranza
La regla en sí: la secuencia de etapas que dispara mensajes, tareas, negativación o protesto a medida que el cobro se acerca al vencimiento y envejece. Las etapas se gestionan en steps, cada una con su disparador (before_due, on_due, after_due + días), su acción y sus canales.
| Comando | HTTP | Descripción |
|---|---|---|
collection-rules list | GET /v1/collection-rules | Listar reglas |
collection-rules create | POST /v1/collection-rules | Crear regla |
collection-rules get | GET /v1/collection-rules/{id} | Consultar regla |
collection-rules update | PUT /v1/collection-rules/{id} | Actualizar regla |
collection-rules delete | DELETE /v1/collection-rules/{id} | Eliminar regla |
collection-rules steps get | GET /v1/collection-rules/{id}/steps | Listar etapas de la regla |
collection-rules steps create | POST /v1/collection-rules/{id}/steps | Crear etapa |
collection-rules steps update | PUT /v1/collection-rules/{id}/steps/{stepId} | Actualizar etapa |
collection-rules steps delete | DELETE /v1/collection-rules/{id}/steps/{stepId} | Eliminar etapa |
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.
# Listar reglas
kobana dunning collection-rules list --fields "id,name,classification_id,is_default,activated_at"
# Crear regla
kobana dunning collection-rules create \
--json '{"name": "Régua padrão", "is_default": true}'
# Listar las etapas de una regla
kobana dunning collection-rules steps get --params '{"id": "RULE_ID"}'
# Agregar etapa: e-mail 3 días antes del vencimiento
kobana dunning collection-rules steps create \
--params '{"id": "RULE_ID"}' \
--json '{"name": "Lembrete D-3", "trigger_type": "before_due", "trigger_days": 3, "action_type": "notification", "channels": ["email"]}'
# Eliminar etapa
kobana dunning collection-rules steps delete --params '{"id": "RULE_ID", "stepId": "STEP_ID"}' --dry-run
Próximos pasos
- Plantillas de mensaje
- Introspección de schema — todos los parámetros que acepta este recurso.