Uso

Sintaxis

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

• <producto> — banking, finance, billing, inbox, dunning o dashboards.
• <recurso> — puede ser anidado: charges, agreements installments, collection-rules steps.
• <metodo> — la acción: list, get, create, update, delete, o una acción específica del recurso.

La versión de la API nunca entra en el comando — el CLI resuelve la URL a partir de la spec OpenAPI embebida.

Los parámetros de URL y de query van en --params; el cuerpo de la solicitud va en --json. Los listados paginan con page/per_page (máximo 100 por página), así que --page-all recorre todas las páginas solo.

Toda la superficie se descubre con --help, en cualquier nivel:

kobana --help                          # productos
kobana dunning --help                  # recursos de Régua de Cobrança
kobana dunning collection-rules --help # métodos de un recurso

Recursos de dunning

Recurso	Descripción
people	Clientes
classifications	Clasificaciones
charges	Cobros
collection-rules	Reglas de cobranza
templates	Plantillas de mensaje
notifications	Notificaciones
notification-channels	Canales de notificación
notification-preferences	Preferencias de notificación
email-layouts	Layouts de e-mail
agreements	Acuerdos
negotiation-campaigns	Campañas de negociación
disputes	Disputas
negativations	Negativaciones
protests	Protestos
interactions	Interacciones
tasks	Tareas
imports	Importaciones
exports	Exportaciones
metrics	Métricas
audit-logs	Pista de auditoría
webhook-endpoints	Endpoints de webhook
me	Identidad del token

Cada recurso tiene su propia página, con la tabla completa de comandos y ejemplos — mira el catálogo.

Ejemplos

# Cobros vencidos de un cliente
kobana dunning charges list \
  --params '{"person_id": "PERSON_ID", "status": "overdue"}' \
  --fields "id,document_number,current_amount,due_date"

# Crear un cliente y un cobro
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 una regla de cobranza a varios cobros
kobana dunning charges bulk-assign-rule create --dry-run \
  --json '{"ids": ["CHARGE_ID_1", "CHARGE_ID_2"], "collection_rule_id": "RULE_ID"}'

# Aceptar un acuerdo y ver sus cuotas
kobana dunning agreements accept --dry-run --params '{"id": "AGREEMENT_ID"}'
kobana dunning agreements installments get --params '{"id": "AGREEMENT_ID"}'

# Listar con paginación automática (NDJSON)
kobana dunning people list --page-all --fields "id,name,document_number"

# Salida en tabla
kobana dunning collection-rules list --output-format table

# Guardar la respuesta en un archivo
kobana dunning people statement-pdf --params '{"id": "PERSON_ID"}' --output extrato.pdf

Próximos pasos

• Introspección de schema — inspecciona parámetros y cuerpo de cualquier endpoint.
• Flags globales — todas las flags que acepta un comando.
• Helpers — atajos +verbo para flujos comunes.
• Recursos — el catálogo completo, recurso por recurso.