Sales summary
get_sales_summaryTakings, number of orders, average order, tips, refunds and cancellations for a period, compared with the same length of time before. Broken down by channel (QR at the table, till, online, delivery apps), by menu category and, for more than one day, by day. Use for 'how did we do today/this week', 'compare with last week'.
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": "get_sales_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day, YYYY-MM-DD, included. Overrides period. | |
| cafe | No | Which café, by name or slug. Only needed when the person has more than one (see list_my_cafes). | |
| from | No | First day, YYYY-MM-DD. Overrides period. | |
| branch | No | One branch (location) by name or id. Leave out for the whole business. | |
| period | No | A named period on the café's clock. Weeks start Monday. | |
| compare | No | Include the period before for comparison. Default true. |