# Get a correction-aware payment report

Source: https://docs.fiest.io/api/reference/get-payment-report
Canonical sandbox contract: https://docs.fiest.io/openapi.yaml

## GET /v1/restaurants/{restaurantId}/payment-report

Returns 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.

## Authentication

Send an OAuth access token in the `Authorization` header as
`Bearer $FIEST_ACCESS_TOKEN`.

Required scopes: `fiest.restaurant.read`, `fiest.accounting.read`

## Quick request

```bash
curl --request GET \
  --url 'https://api-sandbox.fiest.io/v1/restaurants/11111111-1111-4111-8111-111111111111/payment-report?start_date=2026-01-01&end_date=2026-01-31&scope=month' \
  --header 'Authorization: Bearer $FIEST_ACCESS_TOKEN'
```

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `restaurantId` | path | Yes | string (uuid) | A restaurant identifier returned by the authorized restaurant list. |
| `organization_id` | query | No | string (uuid) | 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. |
| `start_date` | query | Yes | string (date) | First restaurant business date, inclusive. |
| `end_date` | query | Yes | string (date) | Last restaurant business date, inclusive. |
| `scope` | query | Yes | string | Report grain. day requires one date; month stays within one calendar month. |

## Success response

### 200 — The raw and correction-aware payment report.

```json
{
  "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
  }
}
```

## Error responses

### 400 — The request parameters are invalid.

```json
{
  "error": "invalid_request",
  "message": "The requested date range is invalid.",
  "request_id": "req_sandbox_invalid_request"
}
```

### 401 — The access token is missing, invalid, or expired.

```json
{
  "error": "invalid_token",
  "error_description": "The access token is invalid.",
  "request_id": "req_sandbox_invalid_token"
}
```

### 403 — The authorization has expired or does not include the required scope.

```json
{
  "error": "insufficient_scope",
  "error_description": "The operation requires an OAuth scope that is not granted.",
  "request_id": "req_sandbox_insufficient_scope"
}
```

### 404 — The restaurant does not exist or is outside the authorization.

```json
{
  "error": "not_found",
  "request_id": "req_sandbox_not_found"
}
```

### 429 — The partner request limit has been exceeded.

```json
{
  "error": "rate_limited",
  "request_id": "req_sandbox_rate_limited"
}
```

### 503 — The API or one of its required services is unavailable.

```json
{
  "error": "service_unavailable",
  "request_id": "req_sandbox_service_unavailable"
}
```

## Related

- [Quick start](https://docs.fiest.io/api/quickstart)
- [Stable API errors](https://docs.fiest.io/api/reference/errors)
- [OpenAPI 3.1 contract, YAML](https://docs.fiest.io/openapi.yaml)
- [OpenAPI 3.1 contract, JSON](https://docs.fiest.io/openapi.json)
- [Authorize and call the Fiest Partner API](https://docs.fiest.io/api/quickstart)