Cuentas de proveedores

Ver la cuenta de un proveedor

Devuelve lo que la empresa debe a un proveedor en cada moneda: saldo, vencido, a favor y antigüedad en cinco tramos.

GET/api/v1/ledger/get-supplier-account

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

supplierIduuidrequerido

Respuesta

200 con este JSON.

supplierobjetorequerido
Campos (5)
- iduuidrequerido
- codeenterorequerido
- legalNametextorequerido
- taxIdtextorequerido
- statusopciónrequerido
  Valores: active inactive
accountslista de objetorequerido
Campos de cada elemento (6)
- currencyCodetextorequerido
- balancetextorequerido
- overduetextorequerido
- inFavortextorequerido
- advancestextorequerido
- agingobjetorequerido
  Campos (5)
  - currenttextorequerido
  - days1to30textorequerido
  - days31to60textorequerido
  - days61to90textorequerido
  - over90textorequerido
hasItemssí o norequerido

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/get-supplier-account?supplierId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/ledger/get-supplier-account?supplierId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90`, {
  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();

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