Retrieve a sales summary
Returns gross and net sales, refunds, discounts, tips, tax and the splits by order type, platform and payment
type, worked out the same way as the Yuze dashboard Overview. Needs reports:read. Branches with different
currencies cannot be added together, so send branchId for those or you get 422 mixed_currencies.
bearerAuthAuthorizationBearer <api_key>branchId?stringString. One branch id from List branches. A branch outside the key's branch list returns 403 branch_forbidden; an id that is not in your company returns 404. Left out: every branch the key can read.
^[A-Za-z0-9_-]{1,128}$from?stringDate YYYY-MM-DD (a London day) or an ISO-8601 date-time with offset. Start of the range, included. Left out: 6 days before to.
to?stringDate YYYY-MM-DD (a London day, included) or an ISO-8601 date-time with offset (excluded). End of the range, at most 92 days after from. Left out: today in London.
groupBy?stringnone or day. day adds a breakdown per London day. Left out: none.
"none""none""day"The summary
application/json- response
data*meta*curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/reports/sales-summary?branchId=YOUR_BRANCH_ID&from=2026-11-11&to=2026-11-11&groupBy=none'{ "data": { "currency": "GBP", "transactionCount": 8, "voidedTransactionCount": 1, "grossSales": 164.8, "netSales": 149.6, "averageSale": 18.7, "refunds": 5, "discounts": 10.2, "tips": 4.4, "tax": 24.93, "serviceCharge": 6.5, "unsettled": 0, "voidedPayments": 12, "salesByOrderType": { "dineIn": 96.2, "delivery": 31.4, "collection": 22, "unclassified": 0 }, "salesByPlatform": { "pos": 118.2, "online": 31.4, "kiosk": 0, "unknown": 0 }, "paymentTypes": [ { "type": "Cash", "amount": 48.8, "tips": 0, "paymentCount": 4 }, { "type": "Card", "amount": 100.8, "tips": 4.4, "paymentCount": 5 } ], "serviceCharges": [ { "name": "Service 10%", "amount": 6.5 } ], "vatBreakdown": [ { "rate": 0.2, "label": "VAT 20%", "sales": 149.6, "vat": 24.93 } ] }, "meta": { "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f", "range": { "from": "2026-11-11T00:00:00.000Z", "to": "2026-11-12T00:00:00.000Z", "fromInput": "2026-11-11", "toInput": "2026-11-11", "timezone": "Europe/London", "toIsExclusive": true }, "branchIds": "all", "generatedAt": "2026-11-12T09:30:00.000Z" }}