Skip to Content
v1.5Documentación oficial de la API LX CloudPos · estable en producción

Consultar cliente

GET /api/v1/clientes/{identificacion}

Consulta un cliente por identificación — cédula física, jurídica, DIMEX o pasaporte. Ver Tipo de identificación.

Autenticación y permisos

AtributoValor
EsquemaAPI key (X-Api-Key)
Scope requeridocatalogo:read
Rate limit120 req/min por API key

Ejemplo

curl https://api.pos.lxsyscr.com/api/v1/clientes/117890123 \ -H "X-Api-Key: $LXS_API_KEY"

Respuestas

200 OK

{ "idCliente": 46, "identificacion": "117890123", "tipoIdentificacion": "01", "nombre": "Cliente Prueba", "apellidos": "Integracion API", "nombreInterno": null, "correo": "cliente.prueba@ejemplo.cr", "telefono": "8888-8888", "direccion": null, "comentario": null, "estado": true, "exonerado": false, "pagaTimbre": false, "limiteCredito": null, "exoneraciones": [ { "idExoneracion": 7, "tipoDocumento": "03", "tipoDocumentoNombre": "Exoneración compras autorizadas de Zona Franca", "numeroDocumento": "EX-2026-00412", "nombreInstitucion": "PROCOMER", "fechaEmision": "2026-01-10T00:00:00Z", "fechaExpiracion": "2027-01-10T00:00:00Z", "porcentajeExoneracion": 100, "estado": true, "vigente": true } ] }

404 Not Found

{ "error": "No existe un cliente con identificación '117890123'." }

Notas operativas

  • No filtra por estado: un cliente desactivado se devuelve de igual forma.
  • exoneraciones es la única forma de obtener el idExoneracion que se manda por línea al emitir un comprobante — ver Exoneraciones. Un cliente sin exoneraciones registradas devuelve el arreglo vacío [].