Solicitar reporte de pagos
POST /api/reports/global-payments/export
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Pagos y cobros con su destino (caja o cuenta), en Excel.
Quién puede usarlo: administradores y vendedores. Si al usuario se le asignaron módulos, necesita el módulo del reporte (Reportes, Inventario o Finanzas, según el caso), igual que en el panel web; si no, responde 403. Un vendedor solo obtiene sus propios comprobantes y movimientos (los que registró o en los que figura como vendedor): el reporte se genera con su usuario aunque envíe filtros de otros.
Formato de respuesta: estándar {success, data, message?} (registro único). Responde 202 Accepted con la fila de la bandeja (data.id, data.status = IN_PROCESS). El archivo se genera en segundo plano: consulta Estado de un reporte y descárgalo con Descargar reporte.
Cuerpo (JSON):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
date_start |
YYYY-MM-DD | Sí | Fecha inicial (inclusive). |
date_end |
YYYY-MM-DD | Sí | Fecha final (inclusive). Igual o posterior a date_start. |
format |
string | No | Solo xlsx (por defecto). |
payment_type |
string | No | document (comprobantes), sale_note, purchase, expense, quotation, contract, income, technical_service, purchase_settlement. |
destination_type |
string | No | cash (caja) o bank_account (cualquier cuenta, billetera o pasarela). |
bank_account_id |
integer | No | Solo esa cuenta (tiene prioridad sobre destination_type). |
Errores:
422siformatespdf(este reporte solo existe en Excel).403si el usuario no tiene el módulo del reporte.422{success: false, message: {campo: [errores]}}si falla la validación de filtros (fechas, formato, ids inexistentes...). No se crea ningún reporte.401sin token o con un token inválido.
Cuerpo
Content-Type: application/json
{
"date_start": "2026-11-01",
"date_end": "2026-11-30",
"payment_type": "document",
"destination_type": "bank_account"
}
Respuestas
202 — En cola
{
"success": true,
"data": {
"id": 58,
"status": "IN_PROCESS",
"ready": false,
"report": "global-payments",
"module": "FINANCE",
"type": "Reporte Pagos",
"format": "xlsx",
"file_name": null,
"user_id": 3,
"date_init": "2026-11-07 10:15:02",
"date_end": null,
"download_url": null
},
"message": "El reporte se está procesando. Consulte su estado en la bandeja de descargas."
}
422 — Filtros inválidos
{
"success": false,
"message": {
"date_end": [
"fecha final debe ser una fecha posterior o igual a fecha inicial."
]
}
}
403 — Sin el módulo del reporte
{
"success": false,
"message": "No tienes acceso al módulo de este reporte."
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.