Listar movimientos
Lista los movimientos de saldo a favor de un cliente.
Descripción general
Este endpoint devuelve un listado paginado de los movimientos de saldo a favor de un cliente, en todas sus monedas. El saldo a favor funciona como un registro de movimientos con signo: los positivos suman saldo y los negativos lo consumen. El saldo disponible de cada moneda es la suma de los montos de sus movimientos.
El listado incluye todos los tipos de movimiento, reversas incluidas, ordenados del más reciente al más antiguo. El tamaño de página es fijo en 20 resultados.
Requiere el permiso Leer en Pagos.
Endpoint
https://app.credonix.mx/api/v1/customers/{customerId}/credit/movementsPath param: customerId — ID del cliente.
Consulta los movimientos de un cliente
Devuelve los movimientos ordenados por created_at descendente. En el ejemplo, un anticipo de 500.00 se aplicó en 300.00 a una orden de cobro, se registró un reembolso de 100.00 y después se revirtió ese reembolso: el saldo disponible en MXN es 200.00.
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
Tipos de movimiento
| Tipo | Signo | Origen |
|---|---|---|
overpayment | Positivo | Excedente de un pago registrado. |
manualAdvance | Positivo | Anticipo registrado con Registrar anticipo. |
applicationToInvoice | Negativo | Saldo aplicado a una orden de cobro con Aplicar saldo a favor. |
refundAdjustment | Negativo | Reembolso registrado con Reembolsar saldo a favor. |
reversal | Contrario al original | Reversa de otro movimiento; reverses_movement_id indica cuál. |
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
id | string | ID del movimiento. |
customer_id | string | Cliente al que pertenece el saldo. |
type | string | Tipo de movimiento. Ver la tabla anterior. |
currency | string | MXN o USD. |
amount | string | Monto con signo y 2 decimales. |
related_invoice_id | string | null | Orden de cobro relacionada con el movimiento. |
related_payment_id | string | null | Pago relacionado con el movimiento. |
reverses_movement_id | string | null | En una reversa, el movimiento que revierte. |
notes | string | null | Notas del movimiento. |
created_by | objeto | null | Quién registró el movimiento: { "type": "api_key" | "user", "name": string }. |
reversed | boolean | true cuando otro movimiento revierte a este. |
created_at | string (fecha) | Momento en que se registró el movimiento. |
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un número entero entre 1 y 107374183. |
401 | — | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Pagos. |
404 | CUSTOMER_NOT_FOUND | El cliente no existe o no pertenece a la organización. |