Cuentas de proveedores

Listar cuentas de proveedores

Lista lo que la empresa debe a cada proveedor, una fila por proveedor y moneda: saldo, antigüedad en cinco tramos y lo que hay a favor, con los totales por moneda.

GET/api/v1/ledger/list-supplier-accounts

Permiso: ledger.view-suppliers
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
balanceopción
Valores: payable overdue in-favor allPor defecto: payable
currencyCodetextoadmite null
formato `^[A-Z]{3}$`
sortopción
Valores: overdue supplier balancePor defecto: overdue
directionopción
Valores: asc descPor defecto: desc
pageentero
Por defecto: 1mínimo 1, máximo 100000
pageSizeentero
Por defecto: 50mínimo 1, máximo 100

Respuesta

200 con este JSON.

accountslista de objetorequerido
Campos de cada elemento (7)
- currencyCodetextorequerido
- balancetextorequerido
- overduetextorequerido
- inFavortextorequerido
- advancestextorequerido
- agingobjetorequerido
  Campos (5)
  - currenttextorequerido
  - days1to30textorequerido
  - days31to60textorequerido
  - days61to90textorequerido
  - over90textorequerido
- supplierobjetorequerido
  Campos (5)
  - iduuidrequerido
  - codeenterorequerido
  - legalNametextorequerido
  - taxIdtextorequerido
  - statusopciónrequerido
    Valores: active inactive
totalenterorequerido
mínimo 0
totalslista de objetorequerido
Campos de cada elemento (6)
- currencyCodetextorequerido
- balancetextorequerido
- overduetextorequerido
- inFavortextorequerido
- advancestextorequerido
- agingobjetorequerido
  Campos (5)
  - currenttextorequerido
  - days1to30textorequerido
  - days31to60textorequerido
  - days61to90textorequerido
  - over90textorequerido
currencieslista de textorequerido

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 `ledger.view-suppliers`.
`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/ledger/list-supplier-accounts" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

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

{
  "accounts": [
    {
      "currencyCode": "texto",
      "balance": "texto",
      "overdue": "texto",
      "inFavor": "texto",
      "advances": "texto",
      "aging": {
        "current": "texto",
        "days1to30": "texto",
        "days31to60": "texto",
        "days61to90": "texto",
        "over90": "texto"
      },
      "supplier": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "code": 1,
        "legalName": "texto",
        "taxId": "texto",
        "status": "active"
      }
    }
  ],
  "total": 1,
  "totals": [
    {
      "currencyCode": "texto",
      "balance": "texto",
      "overdue": "texto",
      "inFavor": "texto",
      "advances": "texto",
      "aging": {
        "current": "texto",
        "days1to30": "texto",
        "days31to60": "texto",
        "days61to90": "texto",
        "over90": "texto"
      }
    }
  ],
  "currencies": [
    "texto"
  ]
}