Listar saldos a favor — Restofy Docs

Descripción

Listado paginado de saldos a favor otorgados a clientes con filtros opcionales.

Detalles

Devuelve los saldos a favor con su saldo vigente, estado, fecha de creación y datos del cliente. Incluye totales agregados del listado.

Permisos requeridos

finance.module

Request

Nombre	Tipo	Requerido	Reglas
search	string	No	max:100
status	string	No	in:active,redeemed,expired,cancelled
isAvailable	bool	No	—

Paginación

defaultLimit	25
maxLimit	100
defaultDir	desc
withTotal	true
allowedSorts	[createdAt, currentBalanceCents, partyName]

Ejemplo de request

curl -X POST https://app.restofy.co/api/favor-balances/list-favor-balances \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>"

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

Ejemplo de respuesta

Actualizado: 2026-07-15T13:20:48Z

HTTP 200

Request

[]

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "favorBalances": [
            {
                "prepaidAccountId": 2,
                "prepaidUuid": "9340b012-7eb3-11f1-ac02-f2368af4d8ac",
                "accountId": 9113,
                "partyId": 1,
                "partyName": "Cliente Crédito",
                "partyPhone": "3000000099",
                "currentBalanceCents": 12000,
                "initialAmountCents": 0,
                "status": "active",
                "isAvailable": 1,
                "createdAt": "2026-07-15T13:18:56.000Z",
                "expiresAt": null
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 25,
            "total": 1,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        },
        "stats": {
            "totalCount": 1,
            "activeCount": "1",
            "outstandingBalanceCents": "12000",
            "totalGrantedCents": "0"
        }
    }
}