Listar deuda con domiciliarios
POST /api/courier-settlements/list-courier-debts
Descripción
Devuelve cuánto se le debe a cada domiciliario por los domicilios que ha llevado.
Detalles
Entrega el listado paginado de domiciliarios con el saldo que el restaurante les debe. Por defecto muestra solo a quienes tienen saldo pendiente, y permite ver a todos. El saldo refleja lo causado por los pedidos entregados menos lo que ya se les pagó. Admite buscar por nombre.
Permisos requeridos
auth-tenant
Request
| Nombre | Tipo | Requerido | Reglas |
|---|---|---|---|
| search | string | No |
max:150
|
| showAll | bool | No | — |
Paginación
| defaultLimit | 25 |
| maxLimit | 100 |
| defaultSort | balanceCents |
| defaultDir | desc |
| withTotal | true |
| allowedSorts | [balanceCents, courierName] |
Ejemplo de request
curl -X POST https://restofy.pro/api/courier-settlements/list-courier-debts \
-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
{
"search": "Repartidor 779118"
}Response
{
"success": true,
"message": "Operación realizada correctamente",
"data": {
"couriers": [],
"stats": {
"courierCount": 0,
"totalDebtCents": "0"
},
"pagination": {
"page": 1,
"limit": 25,
"total": 0,
"totalPages": 0,
"hasNext": false,
"hasPrev": false
}
}
}