Documentation Index
Fetch the complete documentation index at: https://mintlify.com/123048152-JJDS/CafeteriaPM_S203/llms.txt
Use this file to discover all available pages before exploring further.
CafeteriaPM includes built-in report generation for all major operational areas. Every report is available in both PDF (generated with ReportLab) and XLSX (generated with openpyxl) formats and is accessible directly through the API as a file download. All report endpoints return a binary response with a Content-Disposition: attachment header so browsers and HTTP clients treat them as file downloads automatically. Reports are accessed through the /stats/ router and all require the admin role.
Available Reports
| Report | PDF Endpoint | XLSX Endpoint | Role |
|---|
| Sales | GET /stats/reporte-ventas/pdf | GET /stats/reporte-ventas/xlsx | admin |
| Expenses | GET /stats/reporte-gastos/pdf | GET /stats/reporte-gastos/xlsx | admin |
| Products | GET /stats/reporte-productos/pdf | GET /stats/reporte-productos/xlsx | admin |
| Orders | GET /stats/reporte-pedidos/pdf | GET /stats/reporte-pedidos/xlsx | admin |
| Inventory | GET /stats/reporte-inventario/pdf | GET /stats/reporte-inventario/xlsx | admin |
| Activity History | GET /stats/reporte-historial/pdf | GET /stats/reporte-historial/xlsx | admin |
Downloading a Report
Reports are downloaded by making an authenticated GET request and saving the response body to a file.
# Download sales report as PDF
curl http://localhost:8000/stats/reporte-ventas/pdf \
-H "Authorization: Bearer <token>" \
-o ventas_report.pdf
# Download expenses report as XLSX
curl http://localhost:8000/stats/reporte-gastos/xlsx \
-H "Authorization: Bearer <token>" \
-o gastos_report.xlsx
Content-Disposition header specifies the suggested filename:
Content-Disposition: attachment; filename=reporte_ventas.pdf
Content-Disposition: attachment; filename=reporte_gastos.xlsx
Report Query Filters
Most reports accept query parameters to narrow the data included. All date parameters accept ISO 8601 date strings (YYYY-MM-DD).
Sales and Expenses reports (reporte-ventas, reporte-gastos, reporte-historial):
| Parameter | Type | Description |
|---|
fecha_inicio | string | Include records on or after this date |
fecha_fin | string | Include records on or before this date |
reporte-productos):
| Parameter | Type | Description |
|---|
categoria_id | integer | Filter by product category ID |
disponible | boolean | Filter by availability (true or false) |
reporte-pedidos):
| Parameter | Type | Description |
|---|
estado_id | integer | Filter by order state ID |
fecha_inicio | string | Include orders created on or after this date |
fecha_fin | string | Include orders created on or before this date |
"Fechas: <inicio> - <fin>".
# Sales for January 2024
curl "http://localhost:8000/stats/reporte-ventas/pdf?fecha_inicio=2024-01-01&fecha_fin=2024-01-31" \
-H "Authorization: Bearer <token>" \
-o ventas_enero.pdf
# Only available products in category 3
curl "http://localhost:8000/stats/reporte-productos/xlsx?categoria_id=3&disponible=true" \
-H "Authorization: Bearer <token>" \
-o productos_cat3.xlsx
SimpleDocTemplate with US letter page size. Each PDF contains:
- Title header — e.g., “Reporte de Ventas - Cafetería”
- Generation timestamp — the date and time the report was produced
- Filter summary — the date range applied (for reports that accept date filters), rendered in italics
- Data table — a formatted table with a grey header row,
Helvetica-Bold header font, centered alignment, and a grid for all data rows
- Total row — a light-grey highlighted summary row at the bottom (for sales and expense reports)
The Activity History PDF (reporte-historial) is structured differently — it contains three sequential tables on a single document: recent orders, recent sales, and recent expenses, each limited to the 20 most recent records within the date filter.
For single-order receipts, use GET /pedidos/{id}/ticket/pdf instead. Tickets include quantity, product name, unit price, subtotal, and a grand total, and are accessible to admin, caja, and mesero roles.
XLSX files are generated with openpyxl. Each report contains:
- A header row in the first row of the sheet
- One data row per record
- A totals row appended after the data (for sales and expenses)
- Auto-adjusted column widths — each column is sized to fit its longest cell value, capped at 30 characters wide, so the file is immediately readable without manual resizing
The Activity History XLSX (reporte-historial) is the exception — it creates a workbook with three worksheets: Pedidos, Ventas, and Gastos, each populated independently with the same date filters applied. This makes it easy to reference all activity from a single file.
Column Reference
Each report’s data table contains the following columns:
| Report | Columns |
|---|
| Sales | ID Venta, Pedido, Cajero, Método Pago, Monto, Fecha |
| Expenses | ID, Descripción, Categoría, Usuario, Monto, Fecha |
| Products | ID, Nombre, Categoría, Precio, Disponible |
| Orders | ID, Mesa, Mesero, Estado, Total, Fecha |
| Inventory | ID, Nombre, Unidad, Stock actual, Stock mínimo, Estado |
| History (PDF) | Three sub-tables: Orders (ID, Mesa, Estado, Fecha), Sales (ID, Pedido, Monto, Fecha), Expenses (ID, Descripción, Monto, Fecha) |
Admin Web Panel Integration
The admin web panel proxies these API endpoints and presents download buttons directly in the statistics UI at routes prefixed with /proxy/reporte-*. Admin users can download any report from the browser without constructing curl commands manually. The proxy routes pass the same JWT token and forward query parameters, so date filters entered in the UI are applied to the downloaded file.