Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flipdish-payoutreports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Flipdish API - Apps Accounts Payout Reports API
version: v1.0
description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
contact:
name: Flipdish Support
email: help@flipdish.com
url: https://help.flipdish.com
x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
description: Flipdish production API
security:
- oauth2:
- api
tags:
- name: PayoutReports
description: Operations for Payout Reports.
paths:
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview:
get:
tags:
- PayoutReports
operationId: GetPayoutReport3Overview
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PayoutReport3Overview_'
examples:
GetPayoutReport3Overview200Example:
summary: Default GetPayoutReport3Overview 200 response
x-microcks-default: true
value:
Data:
PayoutReport3OverviewHeader:
PayoutId: 500123
BankAccountId: 500123
IsManualPayout: true
AccountName: Example Name
PayoutStatus: Active
CreatedDate: '2026-06-02T12:00:00Z'
PeriodStartTime: '2026-06-02T12:00:00Z'
PeriodEndTime: '2026-06-02T12:00:00Z'
DestinationBank: string
DestinationAccount: string
Amount: 12.5
Currency: EUR
BankAccountHasChanged: true
PayoutStores: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Overview400Example:
summary: Default GetPayoutReport3Overview 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Overview401Example:
summary: Default GetPayoutReport3Overview 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Overview403Example:
summary: Default GetPayoutReport3Overview 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Overview404Example:
summary: Default GetPayoutReport3Overview 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Overview500Example:
summary: Default GetPayoutReport3Overview 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Payout Report3 Overview
description: Get Payout Report3 Overview via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/overview).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores:
get:
tags:
- PayoutReports
operationId: GetPayoutReport3Stores
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: stores
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The stores query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PayoutReport3StorePayouts_'
examples:
GetPayoutReport3Stores200Example:
summary: Default GetPayoutReport3Stores 200 response
x-microcks-default: true
value:
Data:
Stores: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Stores400Example:
summary: Default GetPayoutReport3Stores 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Stores401Example:
summary: Default GetPayoutReport3Stores 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Stores403Example:
summary: Default GetPayoutReport3Stores 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Stores404Example:
summary: Default GetPayoutReport3Stores 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Stores500Example:
summary: Default GetPayoutReport3Stores 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Payout Report3 Stores
description: Get Payout Report3 Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/stores).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders:
get:
tags:
- PayoutReports
operationId: PayoutReport3ExportPayoutOrders
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: stores
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The stores query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_FileCreationResult_'
examples:
PayoutReport3ExportPayoutOrders200Example:
summary: Default PayoutReport3ExportPayoutOrders 200 response
x-microcks-default: true
value:
Data:
FileId: '500123'
Location: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutOrders400Example:
summary: Default PayoutReport3ExportPayoutOrders 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutOrders401Example:
summary: Default PayoutReport3ExportPayoutOrders 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutOrders403Example:
summary: Default PayoutReport3ExportPayoutOrders 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutOrders404Example:
summary: Default PayoutReport3ExportPayoutOrders 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutOrders500Example:
summary: Default PayoutReport3ExportPayoutOrders 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Payout Report3 Export Payout Orders
description: Payout Report3 Export Payout Orders via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/orders).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores:
get:
tags:
- PayoutReports
operationId: PayoutReport3ExportPayoutStores
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: stores
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The stores query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_FileCreationResult_'
examples:
PayoutReport3ExportPayoutStores200Example:
summary: Default PayoutReport3ExportPayoutStores 200 response
x-microcks-default: true
value:
Data:
FileId: '500123'
Location: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutStores400Example:
summary: Default PayoutReport3ExportPayoutStores 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutStores401Example:
summary: Default PayoutReport3ExportPayoutStores 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutStores403Example:
summary: Default PayoutReport3ExportPayoutStores 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutStores404Example:
summary: Default PayoutReport3ExportPayoutStores 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutStores500Example:
summary: Default PayoutReport3ExportPayoutStores 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Payout Report3 Export Payout Stores
description: Payout Report3 Export Payout Stores via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/stores).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details:
get:
tags:
- PayoutReports
operationId: GetPayoutReport3Details
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: storeIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store ids query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PayoutReport3Details_'
examples:
GetPayoutReport3Details200Example:
summary: Default GetPayoutReport3Details 200 response
x-microcks-default: true
value:
Data:
Amount: 12.5
Currency: EUR
Summary:
Revenue: 1.0
RevenueOfWhichCash: 1.0
UnpaidRevenue: 1.0
RevenueForFeeCalculations: 12.5
FlipdishFees: 12.5
Adjustments: 1.0
ThirdPartyIntegrationFeesAndTips: 12.5
Total: 12.5
Revenue:
GrossSales: {}
SalesTax: {}
DeliveryCharges: {}
OtherCharges: {}
Tips: {}
TotalRevenue: {}
RevenueForFeeCalculations: {}
DrsCharges: {}
FlipdishFees:
WebAndAppCash: 1.0
WebAndAppCashRevenueIncludingTips: 1.0
WebAndAppCard: 1.0
WebAndAppCardRevenueIncludingTips: 1.0
KioskCash: 1.0
KioskCashRevenue: 1.0
KioskCard: 1.0
KioskCardRevenue: 1.0
QropCash: 1.0
QropCashRevenue: 1.0
QropCard: 1.0
QropCardRevenue: 1.0
PosCard: 1.0
PosCardRevenue: 1.0
PosCardOnFlipdishOrders: 1.0
OtherIntegrationFees: 12.5
OtherIntegrationFeesExcludingVat: 12.5
OtherIntegrationFeesVatAmount: 12.5
OtherIntegrationTips: 1.0
RefundedFeesOnRefundedSales: 12.5
Vat: 1.0
RefundedFeesOnPosSales: 12.5
Total: 12.5
ThirdPartyIntegrationFeesAndTips: 12.5
WebAndAppCardOnXOrders: 1
WebAndAppCashOnXOrders: 1
KioskCardOnXOrders: 1
KioskCashOnXOrders: 1
QropCardOnXOrders: 1
QropCashOnXOrders: 1
PosCardOnXOrders: 1
Adjustments:
OpeningBalanceDate: '2026-06-02T12:00:00Z'
ClosingBalanceDate: '2026-06-02T12:00:00Z'
OpeningBalance: 1.0
RefundsOnCardOrders: 1.0
RefundsOnCashOrders: 1.0
CashCustomerFees: 12.5
Chargebacks: 1.0
OtherTransactions: 1.0
ClosingBalance: 1.0
BalanceRepaid: 500123
RefundsOnCardOrdersBracketsAmount: 12.5
RefundsOnCardOrdersBracketsOutOfAmount: 12.5
RefundsOnCashOrdersBracketsAmount: 12.5
RefundsOnCashOrdersBracketsOutOfAmount: 12.5
CashCustomerFeesBracketsAmount: 12.5
CashCustomerFeesBracketsOutOfAmount: 12.5
BalanceChange: 1.0
PreviousPayoutId: 500123
NextPayoutId: 500123
RefundedFeesOnChargebacks: 12.5
TotalChargebackCost: 12.5
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Details400Example:
summary: Default GetPayoutReport3Details 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Details401Example:
summary: Default GetPayoutReport3Details 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Details403Example:
summary: Default GetPayoutReport3Details 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Details404Example:
summary: Default GetPayoutReport3Details 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPayoutReport3Details500Example:
summary: Default GetPayoutReport3Details 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get Payout Report3 Details
description: Get Payout Report3 Details via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/details).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/reporting/reports/payouts3/{bankAccountId}/{payoutId}/export/possales:
get:
tags:
- PayoutReports
operationId: PayoutReport3ExportPayoutPosSales
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: bankAccountId
in: path
required: true
schema:
type: integer
format: int32
description: The bank account id path parameter.
example: 500123
- name: payoutId
in: path
required: true
schema:
type: integer
format: int32
description: The payout id path parameter.
example: 500123
- name: stores
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The stores query parameter.
example:
- 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_FileCreationResult_'
examples:
PayoutReport3ExportPayoutPosSales200Example:
summary: Default PayoutReport3ExportPayoutPosSales 200 response
x-microcks-default: true
value:
Data:
FileId: '500123'
Location: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutPosSales400Example:
summary: Default PayoutReport3ExportPayoutPosSales 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
PayoutReport3ExportPayoutPosSales401Example:
summary: Default PayoutReport3ExportPayoutPosSales 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-payoutreports-api-openapi.yml