Restofy Docs
Saldos a favor POST

Listar contactos con saldo a favor

POST /api/favor-balances/list-customers-with-favor-balance

Descripción

Devuelve los contactos con saldo a favor vigente, con o sin filtro de búsqueda.

Detalles

Sin filtro retorna los 5 contactos con mayor saldo a favor, priorizando los más relevantes para el cajero. Con filtro por nombre busca por coincidencia y retorna hasta 25 contactos.

Permisos requeridos

auth-tenant

Request

Nombre Tipo Requerido Reglas
query string No
max:100

Ejemplo de request

curl -X POST https://restofy.pro/api/favor-balances/list-customers-with-favor-balance \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "X-Tenant-Key: <tenantKey>"

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

Ejemplo de respuesta

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

Request

[]

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "customers": [
            {
                "partyId": 1,
                "partyName": "Cliente Crédito",
                "partyPhone": "3000000099",
                "prepaidAccountId": 2,
                "currentBalanceCents": 30000,
                "expiresAt": null
            }
        ]
    }
}