Skip to main content
GET
Get Financial Report Breakdown

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:balance:read

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Sorgu Parametreleri

account_id
string
gerekli

The owning account ID (a biz_ identifier).

bucket
enum<string>
gerekli

The high-level report bucket to explain.

Mevcut seçenekler:
transfers,
payments,
refunds,
ads,
application_fees,
card_spend,
card_authorization_releases,
withdrawals,
withdrawal_markup,
platform_markup,
clawbacks,
disputes,
affiliate_earnings,
affiliate_payouts,
revenue_share,
swaps,
card_loads
direction
enum<string>
gerekli

Whether to explain money received or money sent.

Mevcut seçenekler:
money_in,
money_out
currency
string
gerekli

The report currency to explain.

from
string<date-time>
gerekli

Start of the report window as an ISO 8601 timestamp.

to
string<date-time>
gerekli

Exclusive end of the report window as an ISO 8601 timestamp.

group_by
enum<string>
varsayılan:month

Period grouping used by the parent report.

Mevcut seçenekler:
hour,
day,
week,
month
timezone
string

IANA timezone used by the parent report to bucket periods. Defaults to UTC.

Yanıt

breakdown returned

activity_filters
object
gerekli
bucket
enum<string>
gerekli
Mevcut seçenekler:
transfers,
payments,
refunds,
ads,
application_fees,
card_spend,
card_authorization_releases,
withdrawals,
withdrawal_markup,
platform_markup,
clawbacks,
disputes,
affiliate_earnings,
affiliate_payouts,
revenue_share,
swaps,
card_loads
Örnek:

"transfers"

currency
string
gerekli
Örnek:

"usd"

direction
enum<string>
gerekli
Mevcut seçenekler:
money_in,
money_out
Örnek:

"money_out"

items
object[]
gerekli
Maximum array length: 5
other_amount
object | null
gerekli
other_name
string
gerekli
Örnek:

"Other"