Buscar clientes (formato API de comprobantes)
GET /api/company/customers
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Busca clientes habilitados por número o nombre y los devuelve con los nombres de campo del API de comprobantes (codigo_tipo_documento_identidad, numero_documento...), listos para el bloque datos_del_cliente_o_receptor.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: listado de cantidad fija (take/limit): devuelve como máximo N registros, sin metadatos de paginación. Envuelto en {success, customers[]}; máximo limit registros (30 por defecto, tope 50).
Reglas:
- Sin
inputdevuelve los primeros clientes por nombre.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
input |
query | no | 20601234567 |
Número de documento o nombre (coincidencia parcial). |
identity_document_type_id |
query | no | 6 |
Filtra por tipo de documento. |
limit |
query | no | 30 |
Máximo de registros (1 a 50). |
Respuestas
200 — Clientes
{
"success": true,
"customers": [
{
"id": 25,
"codigo_tipo_documento_identidad": "6",
"numero_documento": "20601234567",
"apellidos_y_nombres_o_razon_social": "COMERCIAL NORTE E.I.R.L.",
"codigo_pais": "PE",
"direccion": "AV. PRINCIPAL 123, LIMA",
"correo_electronico": "compras@comercialnorte.pe",
"telefono": "987654321"
}
]
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.