Skip to main content
GET
Get Payment Overview

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
default:1
per_page
integer | null
default:10
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
start_date
string
required
end_date
string
required
location_ids
string[] | null
payment_mediums
string[] | null
tz
string
required
limit
integer | null
default:5

Response

Successful Response

totalRevenueFromPos
number
required
topSellingItems
TopSellingItemOverview · object[]
required
topCustomers
TopCustomerOverview · object[]
required
period
Period · object
required
todayChange
number
required