Listar
Obtén el listado paginado de los clientes de tu organización.
Descripción general
Este endpoint devuelve un listado paginado de los clientes de tu organización, del más reciente al más antiguo. Cada cliente incluye sus datos generales, fiscales, de dirección y de contacto, y un financial_summary con su resumen de cobranza. El tamaño de página es fijo en 20 resultados.
Puedes buscar por texto y filtrar por clientes con órdenes vencidas o con saldo a favor. Los query params desconocidos se ignoran.
Si no hay un tipo de cambio USD/MXN registrado para calcular el resumen de cobranza, la API responde 500 con EXCHANGE_RATE_NOT_FOUND.
Requiere el permiso Leer en Clientes.
Endpoint
https://app.credonix.mx/api/v1/customersConsulta múltiples clientes
Sin filtros, devuelve todos los clientes ordenados por fecha de creación, del más reciente al más antiguo. Usa page para recorrer las páginas; next y previous conservan los demás query params.
La forma de cada cliente se describe en Consultar cliente.
Query params
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
Busca y filtra clientes
search busca el texto dentro del alias, la razón social o el RFC, sin distinguir mayúsculas y minúsculas. Los filtros se combinan entre sí.
Query params
| Parámetro | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
search | string | No | - | Texto contenido en name, legal_name o tax_id. |
has_overdue | true | false | No | - | true: clientes con al menos una orden de cobro vencida con saldo pendiente. false: clientes sin órdenes vencidas. |
has_credit | true | false | No | - | true: clientes con saldo a favor en al menos una moneda. false: el resto. |
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un número entero entre 1 y 107374183. |
400 | INVALID_QUERY_PARAMETER | has_overdue o has_credit no son exactamente true o false. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Clientes. |
500 | EXCHANGE_RATE_NOT_FOUND | No hay un tipo de cambio USD/MXN registrado. |
{
"code": "INVALID_QUERY_PARAMETER",
"message": "El parámetro has_overdue debe ser true o false.",
"errors": [
{
"field": "has_overdue",
"code": "invalid_value",
"message": "El parámetro has_overdue debe ser true o false."
}
],
"request_id": "1febdbaa-5606-4856-99fc-b6302905c387"
}