Cobranzas

Aplicar saldos a cuenta

Aplica lo que los recibos de un cliente dejaron a cuenta a sus cuotas abiertas, tal como se confirmó. Cada aplicación llega hasta el saldo de la cuota y del crédito, controlado bajo bloqueo.

POST/api/v1/collections/apply-credit

Permiso: collections.apply-credit
Empresa: Opera sobre la empresa activa
Tipo: Escritura: pide Idempotency-Key
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.
Idempotency-Keytextorequerido
Una clave única por intento, de hasta 255 caracteres. Reintentar con la misma clave y los mismos datos devuelve el mismo resultado sin repetir la operación. Ver Idempotencia.

Cuerpo

JSON con Content-Type: application/json.

customerIduuidrequerido
applicationslista de objetorequerido
al menos 1, hasta 200
Campos de cada elemento (3)
- creditItemIduuidrequerido
- itemIduuidrequerido
- amountcualquierarequerido

Respuesta

200 con este JSON.

applicationslista de objetorequerido
Campos de cada elemento (3)
- creditItemIduuidrequerido
- itemIduuidrequerido
- amounttextorequerido
receiptslista de objetorequerido
Campos de cada elemento (3)
- iduuidrequerido
- versionenterorequerido
- advanceBalancetextorequerido

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 `collections.apply-credit`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`409`	Otra persona cambió el registro desde que lo leíste (`record.stale`).
`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 -X POST "$ERP_URL/api/v1/collections/apply-credit" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "applications": [
    {
      "creditItemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "itemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "amount": null
    }
  ]
}'

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/collections/apply-credit`, {
  method: "POST",
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "applications": [
      {
        "creditItemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "itemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "amount": null
      }
    ]
  }),
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "applications": [
    {
      "creditItemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "itemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "amount": "texto"
    }
  ],
  "receipts": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "version": 1,
      "advanceBalance": "texto"
    }
  ]
}