Catálogo de reportes de caja
GET /api/cash-reports/catalog
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Devuelve los reportes de caja disponibles con sus formatos, papeles, secciones y opciones (con su valor inicial según la configuración). Úsalo para construir el selector de reportes y para saber qué parámetros acepta Generar reporte de caja.
Quién puede usarlo: un administrador, siempre y de cualquier caja. Un vendedor solo si la opción available_cash_report_seller está activa (Editar opciones de caja) y solo de sus propias cajas; en otro caso responde 403.
Formato de respuesta: estándar {success, data, message?} (registro único). data es una lista de categorías; cada una trae reports[].
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
all |
0 / 1 | No | Solo administradores: 1 incluye también los reportes ocultos (enabled: false). |
Reportes: cash_close (Cierre de caja), cash_movements (Libro de caja), cash_operations (Resumen de operaciones), cash_credit (Créditos y cobranzas), cash_products (Productos vendidos). Por defecto no vienen los que el administrador ocultó (disabled_cash_reports).
Errores:
403si el usuario no puede generar reportes de caja.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
all |
query | no | 1 |
1 = incluir ocultos (solo administradores). |
Respuestas
200 — Catálogo
{
"success": true,
"data": [
{
"key": "cash",
"label": "Caja",
"description": "Reportes del libro de caja. Todos comparten las mismas cifras.",
"reports": [
{
"type": "cash_close",
"enabled": true,
"toggleable": false,
"label": "Cierre de caja",
"question": "Arqueo del turno: efectivo teórico frente al contado y fondos por destino.",
"description": "Arqueo de efectivo, fondos por destino, cobros por medio de pago y ventas al crédito del turno.",
"audience": [
"Caja",
"Administración"
],
"legacy_consumers": null,
"formats": [
"pdf",
"excel"
],
"papers": [
"a4",
"ticket80",
"ticket58"
],
"sections": [
{
"key": "arqueo",
"label": "Arqueo de efectivo",
"description": "Saldo inicial, ingresos y egresos en efectivo, efectivo teórico y contado.",
"locked": true,
"default": true,
"papers": null,
"formats": null
},
{
"key": "methods",
"label": "Cobros por medio de pago",
"description": "Ingresos y egresos por cada medio de pago.",
"locked": false,
"default": true,
"papers": null,
"formats": null
},
{
"key": "credit",
"label": "Ventas al crédito",
"description": "Comprobantes emitidos al crédito en el turno y su saldo pendiente.",
"locked": false,
"default": true,
"papers": null,
"formats": null
}
],
"options": [
{
"key": "summary",
"label": "Versión resumida",
"type": "checkbox",
"values": null,
"papers": [
"ticket80",
"ticket58"
],
"formats": null,
"default": false
},
{
"key": "all_methods",
"label": "Incluir medios de pago sin movimiento",
"type": "checkbox",
"values": null,
"papers": null,
"formats": null,
"default": false
}
]
}
]
}
]
}
403 — Sin permiso de reportes
{
"success": false,
"message": "No tienes permiso para generar reportes de caja."
}
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.