Clientes

Listar clientes

Lista los clientes con búsqueda por nombre, documento o código y filtros de estado, condición de IVA, modalidad de venta y lista de precios.

GET/api/v1/customers/list

Permiso: customers.view
Empresa: Opera sobre la empresa activa
Tipo: Lectura: no cambia nada
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

searchtextoadmite null
hasta 80 caracteres
statusopción
Valores: active inactive allPor defecto: active
vatConditionuno deadmite null
Una de 2 formas
Forma 1
- valortextorequerido
Forma 2
- valorlista de textorequerido
salesModeuno deadmite null
Una de 2 formas
Forma 1
- valortextorequerido
Forma 2
- valorlista de textorequerido
priceListIduno deadmite null
Una de 2 formas
Forma 1
- valortextorequerido
Forma 2
- valorlista de textorequerido
sortopción
Valores: name codePor defecto: name
pageentero
Por defecto: 1mínimo 1
pageSizeentero
Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

customerslista de objetorequerido
Campos de cada elemento (12)
- iduuidrequerido
- codeenterorequerido
  mínimo 1
- documentTypeopciónrequerido
  Valores: CUIT CUIL DNI
- documentNumbertextorequerido
- legalNametextorequerido
- tradeNamecualquierarequerido
- vatConditionopciónrequerido
  Valores: registered monotributo exempt final_consumer
- salesModeopciónrequerido
  Valores: cash account
- priceListobjetorequeridoadmite null
  Campos (3)
  - iduuidrequerido
  - nametextorequerido
  - statusopciónrequerido
    Valores: active inactive
- citycualquierarequerido
- statusopciónrequerido
  Valores: active inactive
- versionenterorequerido
  mínimo 1
totalenterorequerido
mínimo 0

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

`401`	Falta la credencial o venció.
`403`	La credencial no tiene el permiso `customers.view`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`422`	Datos inválidos o una regla de negocio rota, con el detalle por campo.
`503`	Sistema ocupado: reintentá después de `Retry-After` segundos.

La lista completa está en Errores.

curl
TypeScript

curl "$ERP_URL/api/v1/customers/list" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/customers/list`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "customers": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "code": 1,
      "documentType": "CUIT",
      "documentNumber": "texto",
      "legalName": "texto",
      "tradeName": null,
      "vatCondition": "registered",
      "salesMode": "cash",
      "priceList": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "name": "texto",
        "status": "active"
      },
      "city": null,
      "status": "active",
      "version": 1
    }
  ],
  "total": 1
}