sales_summary
Retrieves revenue totals for a date range, optionally grouped by outlet, day, user or product, and returns sales count, tax, units and average sale value to summarize sales performance.
Instructions
Revenue totals for a local date range (YYYY-MM-DD, inclusive; default today).
group_by: outlet, day, user, product, or none. Counts closed sales by default
(pass states to change). Returns sales count, totals excl/incl tax, tax, units
(product grouping) and average sale value. Returns are included as negatives.
Capped at 20,000 sales per call: narrow the range if truncated is true.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "sales_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | ||
| states | No | ||
| date_to | No | ||
| group_by | No | outlet | |
| date_from | No | ||
| outlet_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |