Summarise sales
loyverse_sales_summaryGet sales totals and ranked breakdowns for any date range by day, item, category, payment type, employee, or store without paging through raw receipts. Cancelled receipts are excluded.
Instructions
Aggregate receipts over a date range into totals and a breakdown, without the model having to page through raw receipts. Reports gross sales, refunds, discounts, tax, tips and net, plus a ranked breakdown by day, item, category, payment type, employee or store. Cancelled receipts are excluded. Without the Unlimited Sales History add-on the account only serves the last 31 days.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Keep only the highest-selling N groups. Ignored when grouping by day. | |
| group_by | No | How to break the totals down. | day |
| store_id | No | Restrict to one store. | |
| max_receipts | No | Safety cap on how many receipts to read. | |
| created_at_max | Yes | End of the range, ISO 8601. Inclusive. | |
| created_at_min | Yes | Start of the range, ISO 8601. Inclusive. |