Sales summary (totals for a period)
lightspeedxseries_sales_summaryTotals for a period computed here from up to max_pages x page_size sales, so a report needs ONE tool call instead of dozens: sale count and net / tax / gross (tax-inclusive) totals, plus breakdowns by state, UTC day, outlet and payment type name, and the top products by quantity. By default only closed sales are counted (states containing 'closed'); set counted_states to change that. Dates are UTC (convert local days with the retailer's time zone). If the reply says truncated, call again with offset = next_offset and add the figures up. Uses GET /search?type=sales.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | Sale state. On-account and layby sales are state closed (they differ by attributes). | |
| offset | No | Offset for the next page: pass next_offset from the previous call (default 0). | |
| date_to | No | Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z). | |
| user_id | No | Only sales by this staff user. | |
| date_from | No | Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone. | |
| max_pages | No | Pages of page_size sales to read (default 5, max 20). | |
| outlet_id | No | Only sales at this outlet. | |
| page_size | No | Sales per page (default 1000). | |
| product_id | No | Only sales containing this product. | |
| customer_id | No | Only sales to this customer. | |
| register_id | No | Only sales on this register. | |
| counted_states | No | Sale states that count towards the totals (exact, case-insensitive). Default: every state containing 'closed'. | |
| invoice_number | No | ||
| payment_type_id | No | Only sales with this payment type (the payment type's config_id, shown as payments[].type.config_id in a sale). |