Pedidos

Controlar el límite de crédito

Indica si confirmar un pedido en borrador lleva al cliente por encima de su límite de crédito: su saldo, más lo no facturado de sus otros pedidos, más este pedido, con IVA. Nunca bloquea la confirmación.

GET/api/v1/sales-orders/check-credit

Permiso: sales-orders.confirm
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

salesOrderIduuidrequerido

Respuesta

200 con este JSON.

creditWarninguno derequeridoadmite null
Una de 2 formas
Forma 1
- exceededconstanterequerido
  Valores: true
- balancetextorequerido
- otherOrderstextorequerido
- thisOrdertextorequerido
- limittextorequerido
- excesstextorequerido
Forma 2
- exceededconstanterequerido
  Valores: true

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 `sales-orders.confirm`.
`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/sales-orders/check-credit?salesOrderId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/sales-orders/check-credit?salesOrderId=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();

{
  "creditWarning": {
    "exceeded": true,
    "balance": "texto",
    "otherOrders": "texto",
    "thisOrder": "texto",
    "limit": "texto",
    "excess": "texto"
  }
}