Catálogo de clientes (receptores de los comprobantes) por negocio. Cada cliente está asociado a un negocio y a un tipo de identificación del SRI.
/customers API KeyLista clientes de un negocio.
Colección paginada: sin page ni perPage recibes la primera página de 25 registros y el bloque meta. Ver Paginación y filtros.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
| page | int | No | Número de página. Por defecto 1. |
| perPage | int | No | Tamaño de página. Por defecto 25, máximo 100. Alias: limit. |
| sortBy | string | No | Campo de ordenamiento. Valores admitidos: id, identification, businessName, email, cellphone, address, createdAt. Por defecto businessName asc. |
| sortDir | string | No | Sentido del ordenamiento: asc o desc. |
| search | string | No | Búsqueda parcial sobre identificación, razón social y correo. |
| identificationTypeId | int | No | Filtra por tipo de identificación. |
| ids | string | No | Lista de IDs separados por coma. Devuelve únicamente esos registros. |
/customers/{id} API KeyObtiene un cliente por su ID.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
/customers/search/{identification} API KeyBusca un cliente por número de identificación. Útil para autocompletar al emitir un comprobante.
Devuelve el primer cliente que coincida con la identificación en cualquiera de los negocios a los que tu API Key tiene acceso.
/customers API KeyCrea un nuevo cliente.
Body
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
| identificationTypeId | int | Sí | Tipo de identificación (ver /catalogs/identification-types). |
| identification | string(20) | Sí | Número de identificación (cédula, RUC, pasaporte…). |
| businessName | string(200) | Sí | Razón social o nombre completo. |
| address | string | No | Dirección del cliente. |
| phoneNumber | string(20) | No | Teléfono fijo. |
| phoneExtension | string(10) | No | Extensión telefónica. |
| cellphone | string(20) | No | Celular. |
| string | No | Correo electrónico (se usa al enviar comprobantes por email). |
json
{
"businessId": 1,
"identificationTypeId": 1,
"identification": "0105678901",
"businessName": "Juan Pérez",
"address": "Av. Principal 123, Quito",
"phoneNumber": "022345678",
"cellphone": "0991234567",
"email": "juan.perez@email.com"
}/customers/{id} API KeyActualiza un cliente existente.
json
{
"businessName": "Juan Carlos Pérez",
"email": "jcperez@email.com"
}/customers/{id} API KeyElimina (soft-delete) un cliente.
json
{ "businessId": 1 }
