Reports
List takings by payment type
GET
Returns takings per payment type for a date range, matching the dashboard "Sales by payment type" card. Needs
reports:read. Amounts are net of refunds, and payments are dated by when they were taken, not when the
transaction was opened.
bearerAuthheader
AuthorizationBearer <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.
Match
^[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.
Payment types
application/json- response
data*meta*curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/reports/payment-types?branchId=YOUR_BRANCH_ID&from=2026-11-11&to=2026-11-11'Example Response
{ "data": { "currency": "GBP", "totals": { "amount": 149.6, "tips": 4.4, "paymentCount": 9 }, "rows": [ { "type": "Cash", "amount": 48.8, "tips": 0, "paymentCount": 4 }, { "type": "Card", "amount": 100.8, "tips": 4.4, "paymentCount": 5 } ] }, "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" }}