Clientes
La cartera: los deudores (personas físicas o jurídicas) a quienes pertenecen los cobros. statement-pdf genera el estado de cuenta del deudor, bulk-archive create archiva hasta 100 clientes de una vez, y los canales de contacto de cada uno (e-mail, teléfono, WhatsApp, dirección) viven en contact-points.
| Comando | HTTP | Descripción |
|---|---|---|
people list | GET /v1/people | Listar clientes |
people create | POST /v1/people | Crear cliente |
people get | GET /v1/people/{id} | Consultar cliente |
people update | PUT /v1/people/{id} | Actualizar cliente |
people delete | DELETE /v1/people/{id} | Eliminar cliente |
people statement-pdf | GET /v1/people/{id}/statement-pdf | Estado de cuenta del deudor (PDF) |
people bulk-archive create | POST /v1/people/bulk-archive | Archivar clientes en masa |
people contact-points list | GET /v1/people/{id}/contact-points | Listar puntos de contacto |
people contact-points create | POST /v1/people/{id}/contact-points | Crear punto de contacto |
people contact-points update | PATCH /v1/people/{id}/contact-points/{cpId} | Actualizar punto de contacto |
people contact-points delete | DELETE /v1/people/{id}/contact-points/{cpId} | Eliminar punto de contacto |
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 clientes
kobana dunning people list \
--params '{"search": "Silva", "per_page": 50}' \
--fields "id,name,document_number,classification_id"
# Crear cliente
kobana dunning people create \
--json '{"name": "Maria da Silva", "document_type": "cpf", "document_number": "12345678901"}'
# Estado de cuenta del deudor en PDF
kobana dunning people statement-pdf --params '{"id": "PERSON_ID"}' --output extrato.pdf
# Agregar un punto de contacto
kobana dunning people contact-points create \
--params '{"id": "PERSON_ID"}' \
--json '{"channel": "whatsapp", "value": "+5511999990000", "is_primary": true}'
# Archivar clientes en masa
kobana dunning people bulk-archive create \
--json '{"ids": ["PERSON_ID_1", "PERSON_ID_2"]}' --dry-run
Próximos pasos
- Clasificaciones
- Introspección de schema — todos los parámetros que acepta este recurso.