Endpoints

Clientes

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.

GET/customers API Key

Lista 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.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
pageint No Número de página. Por defecto 1.
perPageint No Tamaño de página. Por defecto 25, máximo 100. Alias: limit.
sortBystring No Campo de ordenamiento. Valores admitidos: id, identification, businessName, email, cellphone, address, createdAt. Por defecto businessName asc.
sortDirstring No Sentido del ordenamiento: asc o desc.
searchstring No Búsqueda parcial sobre identificación, razón social y correo.
identificationTypeIdint No Filtra por tipo de identificación.
idsstring No Lista de IDs separados por coma. Devuelve únicamente esos registros.
GET/customers/{id} API Key

Obtiene un cliente por su ID.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
GET/customers/search/{identification} API Key

Busca 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.

POST/customers API Key

Crea un nuevo cliente.

Body

CampoTipoRequeridoDescripción
businessIdintID del negocio.
identificationTypeIdintTipo de identificación (ver /catalogs/identification-types).
identificationstring(20)Número de identificación (cédula, RUC, pasaporte…).
businessNamestring(200)Razón social o nombre completo.
addressstring No Dirección del cliente.
phoneNumberstring(20) No Teléfono fijo.
phoneExtensionstring(10) No Extensión telefónica.
cellphonestring(20) No Celular.
emailstring 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"
}
PUT/customers/{id} API Key

Actualiza un cliente existente.

json
{
  "businessName": "Juan Carlos Pérez",
  "email": "jcperez@email.com"
}
DELETE/customers/{id} API Key

Elimina (soft-delete) un cliente.

json
{ "businessId": 1 }