Skip to main content
GET
Get Financial Report

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-31"

Query Parameters

account_id
string
required

The owning account ID (a biz_ identifier), or global for a platform-wide report across all ledger accounts (requires internal admin access).

report_type
enum<string>
required

The type of financial report to generate.

Available options:
balance_summary,
income_statement,
balance_activity
currency
string

Filter rows to this currency, for example usd. Defaults to usd unless in_currency is provided.

in_currency
string

Aggregate all activity into this display currency via FX conversion.

from
string<date-time>

Start of the report window as an ISO 8601 timestamp. Required for platform-wide (global) reports.

to
string<date-time>

Exclusive end of the report window as an ISO 8601 timestamp. Required for platform-wide (global) reports.

group_by
enum<string>
default:month

Grouping granularity for report rows.

Available options:
day,
week,
month
timezone
string

IANA timezone (for example America/New_York) used to bucket report periods. Defaults to UTC. from and to remain exact instants.

line_types
enum<string>[]

Account-level balance activity only: ledger line categories to include.

Available options:
ad_budget_release,
ad_campaign_budget,
ad_publisher_payout,
ad_publisher_payout_received,
ad_spend_charge,
affiliate_fee,
airdrop,
airdrop_link_created,
airdrop_link_redeemed,
airdrop_link_returned,
airdrop_reversal,
application_fee,
application_fee_payout,
balance_reservation,
balance_reservation_reversal,
bank_transfer,
billing_percentage_fee,
buyer_fee,
card_interchange,
card_load_deposit,
card_load_transfer,
card_spend_authorization,
card_spend_authorization_void,
card_spend_refund,
card_unload_deposit,
card_unload_transfer,
company_referral,
connected_account_negative_balance,
cross_border_percentage_fee,
currency_conversion_incoming,
currency_conversion_outgoing,
dispute_alert_fee,
dispute_hold_adjustment,
dispute_representment_fee,
external_card_load_deposit,
fees,
fraud_prevention_fee,
fx_percentage_fee,
high_risk_merchant_fee,
installment_default,
internal_balance_transfer_incoming,
internal_balance_transfer_outgoing,
internal_withdrawal,
internal_withdrawal_complete,
internal_withdrawal_fee,
internal_withdrawal_fee_reversal,
internal_withdrawal_in_transit,
internal_withdrawal_in_transit_reversal,
internal_withdrawal_markup_fee,
internal_withdrawal_markup_fee_payout,
internal_withdrawal_markup_fee_payout_reversal,
internal_withdrawal_markup_fee_reversal,
internal_withdrawal_reversal,
legacy_crypto_payment,
legacy_payment,
legacy_payment_refund,
license_sale,
license_sale_commission,
license_sale_revenue,
marketplace_affiliate_fee,
misc_purchase,
misc_refund,
misc_reversal,
onchain_deposit,
onchain_swap_source,
onchain_swap_target,
onchain_wallet_transfer_incoming,
onchain_wallet_transfer_outgoing,
onchain_withdrawal,
orchestration_percentage_fee,
passthrough_gmv,
payment_dispute,
payment_dispute_adjustment,
payment_dispute_fee,
payment_dispute_reversal,
payment_gross,
payment_gross_reversal,
payment_processing_fixed_fee,
payment_processing_percentage_fee,
payment_referral,
payment_referral_refund,
payment_referral_reversal,
payment_refund,
payment_refund_reversal,
payment_revshare,
payment_revshare_payout,
payment_revshare_refund,
payment_revshare_reversal,
payout_fee,
platform_affiliate_payment,
platform_affiliate_payment_reversal,
platform_balance_payment,
platform_balance_payment_refund,
platform_balance_transfer_fee,
platform_balance_transfer_incoming,
platform_balance_transfer_outgoing,
platform_covered_dispute,
platform_earning,
promo_reversal,
referral_bonus,
resolution_center_refund,
revshare_percentage_fee,
sales_tax_fee,
sales_tax_remittance,
sales_tax_remittance_reversal,
software_rental_revshare,
software_rental_transaction,
stripe_domestic_processing_fee,
stripe_international_processing_fee,
swap_fee,
three_ds_fixed_fee,
topup,
topup_fee,
topup_reversal,
treasury_payin,
whop_processing_fee,
withdrawal,
withdrawal_clawback,
withdrawal_clawback_reversal,
withdrawal_fee,
withdrawal_fee_reversal,
withdrawal_markup_fee,
withdrawal_markup_fee_payout,
withdrawal_markup_fee_payout_reversal,
withdrawal_markup_fee_reversal,
withdrawal_reclassification,
withdrawal_reversal,
withdrawal_topup_adjustment
direction
enum<string>

Account-level balance activity only: include money moving in or money moving out.

Available options:
money_in,
money_out
cumulative
boolean
default:false

Platform-wide (global) reports only: when true, return cumulative balances as of to (all history, no lower bound) instead of activity within the period.

scope_account_id
string

Platform-wide (global) reports only: narrow the report to ledger lines on the ledger account owned by this account ID (a biz_ identifier). Ignored unless account_id is global.

include_payment_fee_breakdown
boolean
default:false

Balance activity only: include payment costs grouped by payment method and provider.

Response

financial report returned

report_type
enum<string>
required

The report that was generated, echoing the requested report_type.

Available options:
balance_summary,
income_statement,
balance_activity
Example:

"balance_summary"

rows
object[]
required
total
number
required
Example:

23750.55

beginning_balance
number | null
Example:

11480.02

currencies
string[]

Every lifetime cashflow currency, ordered by cashflow volume in the requested period.

ending_balance
number | null
Example:

23750.55

fx_excluded_currencies
string[]
payment_fee_breakdown
object[]

Payment costs grouped by customer-facing payment method and provider when requested.