Empresa

Listar empresas

Lista las empresas de la instalación a las que accede el usuario, con búsqueda por razón social o CUIT y filtro por estado.

GET/api/v1/companies/list

Permiso: companies.list
Empresa: No depende de 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.

Parámetros de la consulta

searchtextoadmite null
hasta 80 caracteres
statusopción
Valores: active inactive allPor defecto: active
pageentero
Por defecto: 1mínimo 1
pageSizeentero
Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

companieslista de objetorequerido
Campos de cada elemento (6)
- iduuidrequerido
- legalNametextorequerido
- cuittextorequerido
- vatConditioncualquierarequerido
- statustextorequerido
- activePointsOfSaleenterorequerido
  mínimo 0
totalenterorequerido
mínimo 0
countsobjetorequerido
Campos (3)
- activeenterorequerido
  mínimo 0
- inactiveenterorequerido
  mínimo 0
- allenterorequerido
  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 `companies.list`.
`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/companies/list" \
  -b sesion.txt

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

{
  "companies": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "legalName": "texto",
      "cuit": "texto",
      "vatCondition": null,
      "status": "texto",
      "activePointsOfSale": 1
    }
  ],
  "total": 1,
  "counts": {
    "active": 1,
    "inactive": 1,
    "all": 1
  }
}