Resumen del cuaderno
Cuánto le deben al negocio, cuántos clientes deben, cuánto está vencido, lo fiado y lo abonado en un periodo, el reparto por etapa y los cinco que más deben. Sumado en la base: es la misma cifra que muestra el panel.
Acepta los mismos filtros que GET /v1/receivables (el orden y la paginación no aplican). Los *InRange usan el periodo que dice range — por defecto, el mes en curso en Bogotá.
Permiso: receivables.read.
Autorización
apiKey receivables.readLa llave del negocio, creada en el panel: Integraciones → API pública. vk_live_… es una llave real; vk_test_…, una llave de modo prueba (verificaciones simuladas, nada toca el libro real). Ver la guía «Modo de prueba».
Va en: header
Permiso: receivables.read
Parámetros de consulta
Sobre qué negocio actúa la petición. Obligatorio solo si la llave entra a varios negocios; con uno solo, se deduce.
Busca por nombre, teléfono o correo, sin importar tildes ni mayúsculas («jose» encuentra a «José»). Cada palabra tiene que estar. Un término de 4 dígitos o más busca en el teléfono.
length <= 80Etapas, separadas por coma o repitiendo el parámetro.
true = solo vencidas; false = solo las que no lo están. Sin el parámetro, todas.
Saldo mínimo, en pesos. Admite centavos (hasta 2 decimales): 1100.5 son $1.100,50.
0.01Saldo máximo, en pesos, con hasta 2 decimales.
0.01Total abonado mínimo, en pesos, con hasta 2 decimales.
0.01Total abonado máximo, en pesos, con hasta 2 decimales.
0.01Número mínimo de abonos.
Número máximo de abonos.
Creados desde. Una fecha pelada (2026-09-01) es un día de calendario colombiano: «desde» arranca a las 00:00 de Bogotá y «hasta» cierra a las 23:59:59 de Bogotá. Un ISO completo se respeta tal cual.
Creados hasta, inclusive.
Último abono desde. Una fecha pelada (2026-09-01) es un día de calendario colombiano: «desde» arranca a las 00:00 de Bogotá y «hasta» cierra a las 23:59:59 de Bogotá. Un ISO completo se respeta tal cual.
Último abono hasta, inclusive.
Último fiado desde. Una fecha pelada (2026-09-01) es un día de calendario colombiano: «desde» arranca a las 00:00 de Bogotá y «hasta» cierra a las 23:59:59 de Bogotá. Un ISO completo se respeta tal cual.
Último fiado hasta, inclusive.
Fecha acordada desde. Una fecha pelada (2026-09-01) es un día de calendario colombiano: «desde» arranca a las 00:00 de Bogotá y «hasta» cierra a las 23:59:59 de Bogotá. Un ISO completo se respeta tal cual.
Fecha acordada hasta, inclusive.
Incluir las cuentas saldadas. Por defecto sí (son la columna «Saldada» del tablero); false deja solo las que deben.
truetrue devuelve solo las archivadas (para restaurarlas). Por defecto se excluyen.
falseCuerpo de la respuesta
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/receivables/summary"{ "object": "receivablesSummary", "currency": "COP", "totalBalance": 1845000, "accountsWithBalance": 9, "overdueCount": 3, "overdueBalance": 620000, "chargedInRange": 940000, "chargesCountInRange": 14, "paidInRange": 715000, "paymentsCountInRange": 22, "byStage": { "OPEN": { "count": 3, "balance": 410000 }, "PARTIAL": { "count": 4, "balance": 815000 }, "FOLLOW_UP": { "count": 2, "balance": 620000 }, "PAID": { "count": 6, "balance": 0 } }, "topDebtors": [ { "id": "cmu1f8d3p0021kxw1n6v0bq4m", "name": "Hernán Ospina", "balance": 480000 }, { "id": "cmu4a2k9x000b7qw1h3r5tz8e", "name": "Gloria Restrepo", "balance": 250000 }, { "id": "cmu2d0s7k0009rnw1f4a8wz2c", "name": "Luz Dary Cárdenas", "balance": 210000 }, { "id": "cmu3b5y1e0017rnw1m2k6tq0x", "name": "Carlos Mejía", "balance": 185000 }, { "id": "cmu3c9h4n001arnw1d8p3vg5j", "name": "Yolanda Pérez", "balance": 160000 } ], "range": { "from": "2026-09-01T05:00:00.000Z", "to": "2026-09-30T04:59:59.999Z" }}Ver un cliente GET
La ficha de un cliente con su saldo y sus últimos 50 movimientos, recientes primero; los anulados salen marcados `voided`. Si `entries.hasMore` es `true`, el resto está en `GET /v1/receivables/{id}/entries`. Un cliente archivado también se lee. Permiso: `receivables.read`.
Historial de un cliente GET
Todos los movimientos de un cliente, paginados por cursor, recientes primero. `balanceAfter` es el saldo justo después de cada uno: el estado de cuenta se lee de arriba abajo sin que la columna mienta. Permiso: `receivables.read`.