Skip to main content
GET
Get Financial Report Breakdown

인증

Authorization
string
header
필수

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

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

쿼리 매개변수

account_id
string
필수

The owning account ID (a biz_ identifier).

bucket
enum<string>
필수

The high-level report bucket to explain.

사용 가능한 옵션:
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>
필수

Whether to explain money received or money sent.

사용 가능한 옵션:
money_in,
money_out
currency
string
필수

The report currency to explain.

from
string<date-time>
필수

Start of the report window as an ISO 8601 timestamp.

to
string<date-time>
필수

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

group_by
enum<string>
기본값:month

Period grouping used by the parent report.

사용 가능한 옵션:
hour,
day,
week,
month
timezone
string

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

응답

breakdown returned

activity_filters
object
필수
bucket
enum<string>
필수
사용 가능한 옵션:
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
예시:

"transfers"

currency
string
필수
예시:

"usd"

direction
enum<string>
필수
사용 가능한 옵션:
money_in,
money_out
예시:

"money_out"

items
object[]
필수
Maximum array length: 5
other_amount
object | null
필수
other_name
string
필수
예시:

"Other"