Apariencia
Consultar clientes
POST /api/Invoice/get_clients
Devuelve los clientes activos registrados en el negocio del token. Puedes filtrar por RIF/cédula, nombre o correo; si no envías filtros, devuelve todos. Los datos vienen con los mismos nombres de campo que usas al emitir documentos.
Autenticación: Authorization: Bearer <token> (cómo obtenerlo) · Content-Type: application/json
Cuerpo de la solicitud
Todos los campos son opcionales. Para obtener todos los clientes envía {} o un cuerpo vacío. Los nombres de campo no distinguen mayúsculas/minúsculas (RIF equivale a rif).
| Campo | Tipo | Obligatorio | Descripción y reglas |
|---|---|---|---|
rif | string | No | RIF o cédula, con o sin letra (V12345678, 12345678). La parte numérica debe tener entre 1 y 9 dígitos. Búsqueda parcial: un valor como 1234 encuentra todos los clientes cuyo número contenga 1234. |
nombre | string | No | Nombre o razón social. Búsqueda parcial (contiene). |
correo | string | No | Correo electrónico. Búsqueda parcial (contiene). |
Reglas:
- Solo se admiten esos tres campos; cualquier otro produce error
400. - Si envías un campo, no puede estar vacío. Para no filtrar por él, no lo envíes.
- Si envías varios campos, se combinan (el cliente debe cumplir todos).
Ejemplo de solicitud
json
{
"rif": "J123456789"
}Todos los clientes:
json
{}Respuesta exitosa
HTTP 200
json
{
"success": true,
"message": "Clientes obtenidos exitosamente.",
"total_clientes": 1,
"clientes": [
{
"documentoIdentidadCliente": "J123456789",
"nombreRazonSocialCliente": "Cliente Ejemplo C.A.",
"correoCliente": "cliente@example.com",
"telefonoCliente": "04141234567",
"direccionCliente": "Av. Principal, Caracas"
}
]
}| Clave | Descripción |
|---|---|
success | true si la consulta se realizó (aunque no haya resultados). |
message | Clientes obtenidos exitosamente. |
total_clientes | Cantidad de clientes devueltos. |
clientes[] | Lista de clientes, del más reciente al más antiguo. |
documentoIdentidadCliente | Letra (V, E, P, J, G, C) + número de identificación. |
nombreRazonSocialCliente | Nombre o razón social. |
correoCliente | Correo electrónico registrado. |
telefonoCliente | Teléfono registrado. |
direccionCliente | Dirección registrada. |
Si no hay coincidencias, la respuesta sigue siendo HTTP 200 con "total_clientes": 0 y "clientes": [].
Errores
| HTTP | Mensaje (ejemplo) | Causa |
|---|---|---|
| 400 | El JSON enviado es inválido o está mal formado (Ej: comas adicionales o comillas faltantes). | El cuerpo no es JSON válido. |
| 400 | El JSON enviado contiene campos inválidos (telefono). Los campos permitidos son: rif, nombre, correo. | Se envió un campo distinto de rif, nombre o correo. |
| 400 | Para buscar o filtrar con un dato específico, el campo no puede estar vacío. Verifique (nombre). Si desea obtener todos los clientes, no envíe estos campos. | Algún campo enviado está vacío. |
| 400 | El número de identificación (RIF/Cédula) enviado en el JSON debe contener entre 1 a 9 dígitos numéricos. | rif no contiene dígitos o tiene más de 9. |
| 400 | El comercio indicado aún no está registrado. | El negocio asociado al token no existe. |
| 400 / 401 | Ver Errores | Token ausente, con formato inválido, expirado o no autorizado. |
| 500 | Error en el servidor: ... | Error interno. |
Notas
- Solo se devuelven clientes activos y no eliminados del negocio del token.
- No hay paginación: se devuelven todos los clientes que coincidan.
- Para registrar clientes nuevos usa Registrar clientes.
