VerifikaDocs
ReferenciaCuentas por cobrar

Ver un cliente

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.

GET
/receivables/{id}

Autorización

apiKey receivables.read
AutorizaciónBearer <token>

La 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 la ruta

id*string

Id del cliente (la cuenta por cobrar).

Parámetros de consulta

companyId?string

Sobre qué negocio actúa la petición. Obligatorio solo si la llave entra a varios negocios; con uno solo, se deduce.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/receivables/string"
{  "object": "receivableAccount",  "id": "cmu4a2k9x000b7qw1h3r5tz8e",  "name": "Gloria Restrepo",  "phone": "+573104567890",  "email": null,  "notes": "Mercado de la semana. Paga los viernes.",  "stage": "PARTIAL",  "dueDate": "2026-10-15T05:00:00.000Z",  "isOverdue": false,  "balance": 170000,  "currency": "COP",  "totalCharged": 300000,  "totalPaid": 130000,  "totalWrittenOff": 0,  "chargesCount": 1,  "paymentsCount": 2,  "lastChargeAt": "2026-09-22T14:12:08.431Z",  "lastPaymentAt": "2026-09-26T21:05:33.000Z",  "lastActivityAt": "2026-09-26T21:05:33.118Z",  "branchId": "cmt7xbfrj0002q3w1iq4ysatr",  "source": "API",  "createdBy": null,  "createdAt": "2026-09-22T14:12:08.431Z",  "updatedAt": "2026-09-26T21:05:33.118Z",  "archivedAt": null,  "entries": {    "object": "list",    "data": [      {        "object": "receivableEntry",        "id": "cmu4h7r2t0014bnw1y2e6kd9v",        "accountId": "cmu4a2k9x000b7qw1h3r5tz8e",        "type": "PAYMENT",        "amount": 80000,        "currency": "COP",        "balanceAfter": 170000,        "note": "Abono en efectivo, caja 2",        "occurredAt": "2026-09-26T21:05:33.000Z",        "createdAt": "2026-09-26T21:05:33.118Z",        "source": "API",        "createdBy": null,        "voided": false,        "voidedAt": null,        "voidedBy": null      },      {        "object": "receivableEntry",        "id": "cmu4a2kb4000d7qw1c5x8fj3n",        "accountId": "cmu4a2k9x000b7qw1h3r5tz8e",        "type": "PAYMENT",        "amount": 50000,        "currency": "COP",        "balanceAfter": 250000,        "note": "Abono inicial",        "occurredAt": "2026-09-22T14:12:08.431Z",        "createdAt": "2026-09-22T14:12:08.432Z",        "source": "API",        "createdBy": null,        "voided": false,        "voidedAt": null,        "voidedBy": null      },      {        "object": "receivableEntry",        "id": "cmu4a2kb1000c7qw1p9d2mw6s",        "accountId": "cmu4a2k9x000b7qw1h3r5tz8e",        "type": "CHARGE",        "amount": 300000,        "currency": "COP",        "balanceAfter": 300000,        "note": "Deuda inicial",        "occurredAt": "2026-09-22T14:12:08.431Z",        "createdAt": "2026-09-22T14:12:08.431Z",        "source": "API",        "createdBy": null,        "voided": false,        "voidedAt": null,        "voidedBy": null      }    ],    "hasMore": false,    "nextCursor": null  }}

Registrar un fiado, un abono o una condonación POST

Un movimiento nuevo. El saldo **no se suma ni se resta**: se recalcula releyendo todo el historial, con la fila del cliente bloqueada. Por eso dos abonos simultáneos (la caja y el panel) nunca pasan los dos la validación contra el mismo saldo. - `CHARGE` (fiado) sube el saldo; si la cuenta estaba saldada, la reabre en `OPEN`. - `PAYMENT` (abono) lo baja; el primero sobre `OPEN` la pasa a `PARTIAL`. - `WRITE_OFF` (condonación) lo baja sin contar como pago. - Si el saldo llega a cero, la cuenta pasa a `PAID` sola. Un abono o una condonación por más de lo que debe responde `422 RECEIVABLE_OVERPAYMENT` con el saldo en `details.balance`. Si el cliente pagó todo, `POST …/settle` es más seguro: salda lo que de verdad queda. Permiso: `receivables.write` para `CHARGE` y `PAYMENT`; `receivables.write_off` para `WRITE_OFF`. El permiso se mira **después** de validar el cuerpo, porque depende de `type`.

Resumen del cuaderno GET

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`.