Restaurar un cliente archivado
Lo devuelve al tablero y a los totales con el saldo y la etapa que tenía. Los archivados se listan con GET /v1/receivables?archived=true. Restaurar uno que no estaba archivado devuelve el cliente sin cambiar nada.
Permiso: receivables.write.
Autorización
apiKey receivables.writeLa 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.write
Parámetros de la ruta
Id del cliente (la cuenta por cobrar).
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.
Parámetros de cabecera
Llave única de la operación. Un reintento con la misma llave y el mismo cuerpo devuelve la respuesta original (con Idempotent-Replay: true) en vez de registrar el movimiento otra vez. Ver la guía de idempotencia.
Cuerpo de la respuesta
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/receivables/string/restore"{ "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-28T16:02:55.771Z", "branchId": "cmt7xbfrj0002q3w1iq4ysatr", "source": "API", "createdBy": null, "createdAt": "2026-09-22T14:12:08.431Z", "updatedAt": "2026-09-28T16:02:55.771Z", "archivedAt": null}Listar clientes que deben GET
El cuaderno de fiados, un cliente por fila con su saldo, paginado por cursor. Por defecto, quien más debe primero. Acepta **los mismos filtros** que el tablero y el Excel del panel: si lo que lee tu integración y lo que ve la dueña salieran de filtros distintos, dirían cosas distintas del mismo cuaderno. Para totales usa `GET /v1/receivables/summary`, no sumes páginas. Permiso: `receivables.read`.
Saldar la cuenta POST
Un movimiento por **todo** el saldo, leído con la fila bloqueada: el monto no se manda. Si entre tu consulta y este POST entró otro abono, se salda lo que de verdad queda. La cuenta pasa a `PAID` y sale el evento `receivable.account.paid`. - `mode: "PAYMENT"` — pagó todo. Permiso `receivables.write`. - `mode: "WRITE_OFF"` — se le perdona todo. Permiso `receivables.write_off`. El movimiento se fecha ahora. Si la cuenta ya está en cero → `422 RECEIVABLE_ALREADY_PAID`.