Financial summary
hub_get_financial_summaryTHE headline money report for a date range — the same numbers as Reports → Financial Summary. Answers 'how much did we make last week', 'what were sales this month', 'how much tax do I owe', 'what lands in my bank'. Returns gross sales, discounts, refunds, fees, tax, tips, net sales, and the settlement split (card / cash / custom) down to what the merchant actually receives. Start here for any "how did the business do" question, and only reach for get_sales_breakdown when the merchant wants the individual orders behind these totals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | Yes | End of the window, ISO 8601. Inclusive of the day when a bare date is given | |
| outlets | No | Outlet ids to restrict to. Omit for all outlets | |
| stations | No | Station ids to restrict to. Omit for all stations | |
| startDate | Yes | Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z" |