Fiest Developers

Find payment-method correction targets

Returns a correction-aware day or calendar-month report plus up to 500 exact payment source identities.

GET/v1/restaurants/{restaurantId}/payment-correction-workspace

Returns a correction-aware day or calendar-month report plus up to 500 exact payment source identities. Use scope=day for one business date, scope=month for a bounded calendar-month review, and query to narrow by receipt hash, order, tab, or tab-split identity. Select one returned source before previewing a correction. This is a gated write-preparation operation and does not mutate data. Organization-boundary tokens also require fiest.organization.read; when a token covers several organizations, organization_id must identify an exact organization returned by listOrganizations.

Quick request

curl -X GET "https://example.com/v1/restaurants/11111111-1111-4111-8111-111111111111/payment-correction-workspace?organization_id=33333333-3333-4333-8333-333333333333&start_date=2026-07-15&end_date=2026-07-15&scope=day&query=receipt-hash-example" \  -H "Authorization: Bearer $FIEST_ACCESS_TOKEN"
{  "data": {    "restaurantId": "11111111-1111-4111-8111-111111111111",    "report": {      "refundReporting": {        "policy": "refund-event-date/v1",        "legacyTiming": false,        "incompleteEvidence": false      },      "restaurantId": "11111111-1111-4111-8111-111111111111",      "scope": "day",      "period": {        "startDate": "2026-07-15",        "endDate": "2026-07-15",        "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    },    "sources": [      {        "sourceKind": "order",        "sourceRecordId": "fiest-50b6d34f-bc6e-4248-b3d6-839b3dda31a1",        "sourceKey": "order:fiest-50b6d34f-bc6e-4248-b3d6-839b3dda31a1",        "receiptHash": "receipt-hash-example",        "parentReceiptHash": null,        "componentId": null,        "tabSplitId": null,        "businessDate": "2026-07-15",        "methodKey": "card",        "grossMinor": 1350,        "transactionCount": 1,        "sourceGroupId": null,        "sourceGroupGrossMinor": null,        "grossByRateMinor": {          "zero": 0,          "special": 0,          "reduced": 1350,          "standard": 0,          "unknown": 0        },        "vatByRateMinor": {          "zero": 0,          "special": 0,          "reduced": 161,          "standard": 0,          "unknown": 0        },        "resolutionStatus": "resolved"      }    ],    "methods": [      {        "key": "card",        "label": "Card"      },      {        "key": "cash",        "label": "Cash"      },      {        "key": "online",        "label": "Online"      }    ],    "canWrite": true  }}

Authorization

fiestOAuth fiest.restaurant.read, fiest.accounting.read, fiest.analytics.read, fiest.accounting.corrections.write
AuthorizationBearer <token>

OAuth 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, fiest.analytics.read, fiest.accounting.corrections.write

Path Parameters

restaurantId*string

A restaurant identifier returned by the authorized restaurant list.

Formatuuid

Query Parameters

organization_id?string

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.

Formatuuid
start_date*string

First restaurant business date, inclusive.

Formatdate
end_date*string

Last restaurant business date, inclusive. It cannot be in the future and the range may contain at most 31 days.

Formatdate
scope*string

Report grain. day requires one date; month stays within one calendar month.

Value in

  • "day"
  • "month"
query?string

Optional exact-source search text. It may match a receipt hash, order identity, tab identity, or tab-split identity.

Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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.

Preview one payment-method correction

Builds a before-and-after report for one exact order, tab, tab-split, or other returned payment source.