Saltar al contenido principal

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.

ComandoHTTPDescripción
people listGET /v1/peopleListar clientes
people createPOST /v1/peopleCrear cliente
people getGET /v1/people/{id}Consultar cliente
people updatePUT /v1/people/{id}Actualizar cliente
people deleteDELETE /v1/people/{id}Eliminar cliente
people statement-pdfGET /v1/people/{id}/statement-pdfEstado de cuenta del deudor (PDF)
people bulk-archive createPOST /v1/people/bulk-archiveArchivar clientes en masa
people contact-points listGET /v1/people/{id}/contact-pointsListar puntos de contacto
people contact-points createPOST /v1/people/{id}/contact-pointsCrear punto de contacto
people contact-points updatePATCH /v1/people/{id}/contact-points/{cpId}Actualizar punto de contacto
people contact-points deleteDELETE /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​