Proveedores

Listar proveedores

Lista los proveedores con búsqueda por nombre, CUIT o código y filtros de tipo, condición de IVA y estado.

GET/api/v1/suppliers/list

Permiso: suppliers.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
supplierTypelista de opción
Valores: goods services goods-and-services carrier
vatConditionlista de opción
Valores: registered monotributo exempt
statusopción
Valores: active inactive allPor defecto: active
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.

supplierslista de objetorequerido
Campos de cada elemento (13)
- iduuidrequerido
- codeenterorequerido
  mínimo 1
- legalNametextorequerido
- tradeNamecualquierarequerido
- originopciónrequerido
  Valores: domestic foreign
- cuitcualquierarequerido
- cuitFormattedcualquierarequerido
- countryCodecualquierarequerido
- countryNamecualquierarequerido
- vatConditionopciónrequeridoadmite null
  Valores: registered monotributo exempt
- supplierTypeopciónrequerido
  Valores: goods services goods-and-services carrier
- paymentTermNamecualquierarequerido
- statusopciónrequerido
  Valores: active inactive
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 `suppliers.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/suppliers/list" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/suppliers/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();

{
  "suppliers": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "code": 1,
      "legalName": "texto",
      "tradeName": null,
      "origin": "domestic",
      "cuit": null,
      "cuitFormatted": null,
      "countryCode": null,
      "countryName": null,
      "vatCondition": "registered",
      "supplierType": "goods",
      "paymentTermName": null,
      "status": "active"
    }
  ],
  "total": 1
}