Restofy Docs
Saldos a favor POST

Detalle de saldo a favor

POST /api/favor-balances/get-favor-balance

Descripción

Devuelve un saldo a favor del cliente con sus últimos movimientos.

Detalles

Retorna los datos del saldo a favor (cliente, saldo vigente, estado, fechas) y los últimos 50 movimientos que sumaron o consumieron ese saldo.

Permisos requeridos

finance.module

Request

Nombre Tipo Requerido Reglas
prepaidAccountId int
min_value:1

Ejemplo de request

curl -X POST https://restofy.pro/api/favor-balances/get-favor-balance \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "X-Tenant-Key: <tenantKey>" \
  -d '{
    "prepaidAccountId": 1
}'

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-09-08T16:35:34Z
HTTP 200

Request

{
    "prepaidAccountId": "2"
}

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "favorBalance": {
            "prepaidAccountId": 2,
            "prepaidUuid": "41d3917c-ab4a-11f1-b72d-f2569efa6eee",
            "accountId": 9113,
            "partyId": 1,
            "partyName": "Cliente Crédito",
            "partyPhone": "3000000099",
            "currentBalanceCents": 12000,
            "initialAmountCents": 0,
            "notes": "test",
            "status": "active",
            "isAvailable": 1,
            "createdByActorId": 15,
            "createdAt": "2026-09-08T16:31:48.000Z",
            "expiresAt": null
        },
        "movements": [
            {
                "entryCode": "FAVORBAL-20260908-11734EC9",
                "entryType": "favor_balance_grant",
                "description": "Saldo a favor de Cliente Crédito: test grant",
                "status": "normal",
                "occurredAt": "2026-09-08T16:31:48.000Z",
                "debitCents": 0,
                "creditCents": 12000
            }
        ]
    }
}