Dashboard Summary
curl -X GET "http://localhost:8080/api/v1/reports/dashboard-summary" \
-H "Authorization: Bearer YOUR_TOKEN"
Get high-level summary metrics for the dashboard.
Response
Show DashboardSummaryResponse
Number of unique cashiers
Roles
Accessible by: admin, manager, cashier
Sales Reports
curl -X GET "http://localhost:8080/api/v1/reports/sales?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get aggregated sales data grouped by date within a specified range.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of daily sales summaries
Number of orders on this date
Total sales amount for this date
Roles
Accessible by: admin, manager, cashier
curl -X GET "http://localhost:8080/api/v1/reports/products?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get sales performance metrics for each product.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of product performance dataShow ProductPerformanceResponse
Total revenue from this product
Roles
Accessible by: admin, manager, cashier
curl -X GET "http://localhost:8080/api/v1/reports/payment-methods?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get usage counts and totals for each payment method.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of payment method performance dataShow PaymentMethodPerformanceResponse
Number of orders using this payment method
Total sales amount via this payment method
Roles
Accessible by: admin, manager, cashier
curl -X GET "http://localhost:8080/api/v1/reports/cashier-performance?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get order counts and sales totals handled by each cashier.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of cashier performance dataShow CashierPerformanceResponse
Number of orders processed by this cashier
Total sales amount processed by this cashier
Roles
Accessible by: admin, manager, cashier
Cancellation Reports
curl -X GET "http://localhost:8080/api/v1/reports/cancellations?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get statistics on order cancellations grouped by reason.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of cancellation statisticsShow CancellationReportResponse
Cancellation reason description
Number of orders cancelled for this reason
Roles
Accessible by: admin, manager, cashier
Profit Summary
curl -X GET "http://localhost:8080/api/v1/reports/profit-summary?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get gross profit analytics grouped by date.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of daily profit summariesShow ProfitSummaryResponse
Total revenue for this date
Gross profit (revenue - COGS)
Roles
Accessible by: admin, manager, cashier
Product Profit Reports
curl -X GET "http://localhost:8080/api/v1/reports/profit-products?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"
Get profitability metrics for each product sold.
Query Parameters
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Response
Array of product profit dataShow ProductProfitResponse
Total revenue from this product
Gross profit for this product
Roles
Accessible by: admin, manager, cashier