Cuentas corrientes

Ver la cuenta de un cliente

Devuelve la cuenta de un cliente: saldo, vencido, a cuenta, antigüedad en cinco tramos, límite de crédito y si tiene partidas.

GET/api/v1/ledger/get-account

Permiso: ledger.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

customerIduuidrequerido

Respuesta

200 con este JSON.

balancetextorequerido
overduetextorequerido
onAccounttextorequerido
advancestextorequerido
agingobjetorequerido
Campos (5)
- currenttextorequerido
- days1to30textorequerido
- days31to60textorequerido
- days61to90textorequerido
- over90textorequerido
customerobjetorequerido
Campos (4)
- iduuidrequerido
- legalNametextorequerido
- documentTypetextorequerido
- documentNumbertextorequerido
creditLimitcualquierarequerido
hasItemssí o norequerido
circuitsobjetorequeridoadmite null
Campos (2)
- fiscalobjetorequerido
  Campos (5)
  - balancetextorequerido
  - overduetextorequerido
  - onAccounttextorequerido
  - advancestextorequerido
  - agingobjetorequerido
    Campos (5)
    currenttextorequerido
    days1to30textorequerido
    days31to60textorequerido
    days61to90textorequerido
    over90textorequerido
- xobjetorequerido
  Campos (5)
  - balancetextorequerido
  - overduetextorequerido
  - onAccounttextorequerido
  - advancestextorequerido
  - agingobjetorequerido
    Campos (5)
    currenttextorequerido
    days1to30textorequerido
    days31to60textorequerido
    days61to90textorequerido
    over90textorequerido

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`.
`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-account?customerId=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-account?customerId=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();

{
  "balance": "texto",
  "overdue": "texto",
  "onAccount": "texto",
  "advances": "texto",
  "aging": {
    "current": "texto",
    "days1to30": "texto",
    "days31to60": "texto",
    "days61to90": "texto",
    "over90": "texto"
  },
  "customer": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "legalName": "texto",
    "documentType": "texto",
    "documentNumber": "texto"
  },
  "creditLimit": null,
  "hasItems": false,
  "circuits": {
    "fiscal": {
      "balance": "texto",
      "overdue": "texto",
      "onAccount": "texto",
      "advances": "texto",
      "aging": {
        "current": "texto",
        "days1to30": "texto",
        "days31to60": "texto",
        "days61to90": "texto",
        "over90": "texto"
      }
    },
    "x": {
      "balance": "texto",
      "overdue": "texto",
      "onAccount": "texto",
      "advances": "texto",
      "aging": {
        "current": "texto",
        "days1to30": "texto",
        "days31to60": "texto",
        "days61to90": "texto",
        "over90": "texto"
      }
    }
  }
}