Get a correction-aware payment report
Returns raw payment-method totals plus adjusted totals only when the immutable Dashboard correction ledger and current source VAT/count evidence reconcile.
/v1/restaurants/{restaurantId}/payment-reportReturns raw payment-method totals plus adjusted totals only when the immutable Dashboard correction ledger and current source VAT/count evidence reconcile. Use scope=day for one business date or scope=month for a bounded calendar-month view. A review_required or blocked_stale result keeps adjusted values null and includes warnings; raw accounting values remain explicitly marked as services_accounting. For bookkeeping, pair with accounting-summary for identical restaurant, currency, business dates, timezone, and day cutoff. Ready requires complete known VAT evidence and conserved gross/net/VAT/count totals. Replace the raw method allocation rather than posting sales or VAT twice. Retain the imported snapshot to reconcile later corrections and reversals.
Quick request
curl -X GET "https://example.com/v1/restaurants/11111111-1111-4111-8111-111111111111/payment-report?organization_id=33333333-3333-4333-8333-333333333333&start_date=2026-01-01&end_date=2026-01-31&scope=month" \ -H "Authorization: Bearer $FIEST_ACCESS_TOKEN"{ "data": { "refundReporting": { "policy": "refund-event-date/v1", "legacyTiming": false, "incompleteEvidence": false }, "restaurantId": "11111111-1111-4111-8111-111111111111", "scope": "month", "period": { "startDate": "2026-01-01", "endDate": "2026-01-31", "timeZone": "Europe/Helsinki", "dayStartHour": 4 }, "currency": "EUR", "rawRows": [ { "key": "card", "label": "Card", "transactionCount": 459, "grossMinor": 2795000, "netMinor": 2390000, "vatMinor": 405000, "grossByRateMinor": null, "vatByRateMinor": null } ], "adjustedRows": null, "rawTotalMinor": 2795000, "adjustedTotalMinor": null, "status": "review_required", "warnings": [ { "code": "correction_ledger_unavailable", "message": "Raw values are available; adjusted values need review.", "businessDate": null, "correctionId": null } ], "days": [], "corrections": [], "sources": [], "appliedCorrectionIds": [], "rawSourceBasis": "services_accounting", "calculationVersion": "services-accounting/payment-report/1", "schemaVersion": null, "currentSourceFingerprint": null, "readOnly": true }}Authorization
fiestOAuth fiest.restaurant.read, fiest.accounting.readOAuth 2.1 authorization code with PKCE. Partner clients and redirect URIs must be approved by Fiest before use.
In: header
Scope: fiest.restaurant.read, fiest.accounting.read
Path Parameters
A restaurant identifier returned by the authorized restaurant list.
uuidQuery Parameters
An organizationId returned by GET /v1/organizations. Required for restaurant-scoped calls when a Management portfolio authorization covers more than one organization; omitted for a single-restaurant authorization and optional for a one-organization grant.
uuidFirst restaurant business date, inclusive.
dateLast restaurant business date, inclusive.
dateReport grain. day requires one date; month stays within one calendar month.
Value in
- "day"
- "month"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json