Skip to main content
GET
Get Payment Breakdown

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

group_by
enum<string> | null
Available options:
location,
provider,
payment_medium,
created_date,
week,
month
group_key
string | null
timezone
string
required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

sort_by
string
default:created_date
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
start_date
string | null
end_date
string | null
location_ids
string[] | null
location_names
string[] | null
payment_mediums
string[] | null
payment_statuses
string[] | null
min_amount
number | null
max_amount
number | null
comment
string | null
location
string | null
provider
string | null
payment_medium
string | null
created_date
string | null
week
string | null
month
string | null
page
integer | null
per_page
integer | null

Response

Successful Response

data
PaymentBreakdownItem · object[]
required
total
integer
required