Skip to content

/api/external/reports/{reportType}

GET
/api/external/reports/{reportType}

Run a Tebi report

Authorizations

Parameters

Path Parameters

reportType
required
string

The type of report to run, possible values: DayReport, DayReportV2, RevenueReport, ProductReport, ProductReportWithModifiers, ProductReportByProfitCenter, StockReport, CogsReport, CategoryReport, DiscountReport, SurchargeReport, PaymentReport, ProductOrdersReport, SalesReport, SalesByCustomerReport, UserOverviewReport, CoversReport, BookkeepingDayExport, LabourCostPercentageReport, GiftcardsReport

Example
RevenueReport

Query Parameters

startDate
required
string

The start date of the report

Example
2023-01-27
endDate
string

The end date (inclusive) of the report

Example
2023-01-28

Responses

200

string format: byte

400

Failure code for InvalidData

object
message
required
string
label
string
nullable
validation
required
Array<object>
object
key
required
string
message
required
string

403

Failure code for InvalidPermission

object
message
required
string
label
string
nullable
validation
required
Array<object>
object
key
required
string
message
required
string

404

Failure code for NotFound

object
message
required
string
label
string
nullable
validation
required
Array<object>
object
key
required
string
message
required
string

500

Failure code for UnknownError

object
message
required
string
label
string
nullable
validation
required
Array<object>
object
key
required
string
message
required
string