Stock

Listar saldos de stock

Lista los saldos por artículo y depósito (físico, no disponible y disponible), con búsqueda y filtros de depósito, familia, marca y saldo.

GET/api/v1/stock/list-balances

Permiso: stock.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 100 caracteres
warehouseIduuidadmite null
familyIduuidadmite null
brandIduuidadmite null
balanceopción
Valores: with-stock without-stock allPor defecto: with-stock
sortopción
Valores: code item warehouse physical available cost value relevancePor defecto: code
directionopción
Valores: asc descPor defecto: asc
countTotalsí o no
groupByopción
Valores: warehouse itemPor defecto: warehouse
itemIdsuno deadmite null
Una de 2 formas
Forma 1
- valortextorequerido
Forma 2
- valorlista de textorequerido
pageentero
Por defecto: 1mínimo 1
pageSizeentero
Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

balanceslista de objetorequerido
Campos de cada elemento (8)
- itemobjetorequerido
  Campos (7)
  - iduuidrequerido
  - codetextorequerido
  - nametextorequerido
  - statusopciónrequerido
    Valores: active inactive
  - unitCodetextorequerido
  - unitNametextorequerido
  - allowsDecimalssí o norequerido
- warehouseobjetorequerido
  Campos (4)
  - iduuidrequerido
  - codetextorequerido
  - nametextorequerido
  - statusopciónrequerido
    Valores: active inactive
- physicalnúmerorequerido
- unavailablenúmerorequerido
- reservednúmerorequerido
- availablenúmerorequerido
- averageCostcualquiera
- bookValuecualquiera
totalentero
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 `stock.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/stock/list-balances" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

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

{
  "balances": [
    {
      "item": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "code": "texto",
        "name": "texto",
        "status": "active",
        "unitCode": "texto",
        "unitName": "texto",
        "allowsDecimals": false
      },
      "warehouse": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "code": "texto",
        "name": "texto",
        "status": "active"
      },
      "physical": 100,
      "unavailable": 100,
      "reserved": 100,
      "available": 100,
      "averageCost": null,
      "bookValue": null
    }
  ],
  "total": 1
}