Consultar | Credonix

Descripción general

Este endpoint devuelve un cliente con sus datos generales, fiscales, de dirección y de contacto, y un financial_summary con lo cobrado, lo vencido, lo pendiente y su saldo a favor.

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

GEThttps://app.credonix.mx/api/v1/customers/{customerId}

Path param: customerId — el id del cliente.

Consulta un cliente

Devuelve el cliente con su resumen de cobranza calculado al momento de la consulta. Los contactos adicionales del cliente se consultan en Listar contactos.

Cliente inexistente

Si el id no existe, o pertenece a otra organización, la API responde 404 con el código NOT_FOUND. Un cliente eliminado también responde 404.

Campos de la respuesta

Campo	Tipo	Descripción
`id`	string	Identificador del cliente.
`name`	string	Alias del cliente.
`legal_name`	string \| null	Razón social, en mayúsculas.
`tax_id`	string \| null	RFC, en mayúsculas y sin guiones ni espacios.
`tax_regime`	string \| null	Régimen fiscal.
`website`	string \| null	Sitio web.
`address_street`	string \| null	Calle.
`address_exterior_number`	string \| null	Número exterior.
`address_interior_number`	string \| null	Número interior.
`address_neighborhood`	string \| null	Colonia.
`address_city`	string \| null	Ciudad.
`address_state`	string \| null	Estado.
`address_country`	string \| null	País.
`address_zip_code`	string \| null	Código postal.
`contact_name`	string \| null	Nombre del contacto principal.
`contact_phone`	string \| null	Teléfono del contacto principal.
`contact_email`	string \| null	Correo del contacto principal.
`contact_second_email`	string \| null	Segundo correo del contacto principal.
`send_weekly_message`	boolean	Si el cliente recibe el mensaje semanal.
`financial_summary`	objeto	Resumen de cobranza. Ver abajo.
`created_at`	string	Fecha de creación (ISO 8601).
`updated_at`	string	Fecha de la última actualización (ISO 8601).

`financial_summary`

Los montos se expresan en MXN: los importes en USD se convierten con el tipo de cambio USD/MXN más reciente.

Campo	Descripción
`currency`	Moneda de los totales: `MXN`.
`total_collected`	Suma de los pagos no cancelados de las órdenes de cobro del cliente, incluidas las aplicaciones de saldo a favor.
`total_overdue`	Saldo pendiente de las órdenes con estatus `overdue`.
`total_pending`	Saldo pendiente de las órdenes con estatus `issued` u `overdue`.
`last_payment_date`	Fecha (`YYYY-MM-DD`) del pago no cancelado más reciente, o `null`.
`next_scheduled_date`	Fecha (`YYYY-MM-DD`) más próxima entre la fecha de emisión futura de sus órdenes con estatus `issued`, `overdue` o `created` y la próxima ejecución de sus automatizaciones activas, o `null`.
`credit_balances`	Saldo a favor por moneda (`currency`, `amount`). Solo incluye monedas con saldo positivo.

Todos los importes se devuelven como string con dos decimales.

Errores

Status	Código	Causa
`403`	`INSUFFICIENT_PERMISSIONS`	La API key no tiene el permiso Leer en Clientes.
`404`	`NOT_FOUND`	El cliente no existe en esta organización.
`500`	`EXCHANGE_RATE_NOT_FOUND`	No hay un tipo de cambio USD/MXN registrado.