Sign in
Ledgers

Get Financial Report

Returns a financial report — balance activity, income statement, or balance summary — for an account over a date range.

get/financial_reports

Query parameters

account_idstring 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'balance_summary' | 'income_statement' | 'balance_activity' required

The type of financial report to generate.

currencystring

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

in_currencystring

Aggregate all activity into this display currency via FX conversion.

fromstring date-time

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

tostring date-time

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

group_by'hour' | 'day' | 'week' | 'month'

Grouping granularity for report rows. Hourly grouping is supported for account-level balance activity reports only; hourly periods are timestamps in the requested timezone.

timezonestring

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

line_typesstring[]

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

direction'money_in' | 'money_out'

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

cumulativeboolean

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_idstring

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_breakdownboolean

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

Headers

Api-Version-Datestring
Example:2026-09-25

Pins the request to a dated API version.

Response

financial report returned

beginning_balancenumber nullable
currenciesstring[]

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

ending_balancenumber nullable
fx_excluded_currenciesstring[]
report_type'balance_summary' | 'income_statement' | 'balance_activity' required

The report that was generated, echoing the requested report_type.

totalnumber required

Example response

{
  "beginning_balance": 11480.02,
  "currencies": [
    "usd"
  ],
  "ending_balance": 23750.55,
  "fx_excluded_currencies": [
    "ngn"
  ],
  "payment_fee_breakdown": [
    {
      "amount": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "category": "app_store_payments"
    }
  ],
  "report_type": "balance_summary",
  "rows": [
    {
      "account_ik_path": "assets/wallets/wallet/available",
      "account_name": "Available balance",
      "account_type": "asset",
      "amount": 23750.55,
      "grouping": "payments",
      "line_category": "payment_gross",
      "line_count": 214,
      "period": "2026-05",
      "profit_and_loss_section": "revenue"
    }
  ],
  "total": 23750.55
}

Changes

Changed in 26 of the 74 revisions of this API.32525

  • c1dceb26e50543See the full diff
    • ●

      added the new platform_credits enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new platform_credits_granted enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new platform_credits_payment enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new platform_credits_payment_refund enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value platform_credits_granted to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value platform_credits_payment to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value platform_credits_payment_refund to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

  • ac2b9b1c6a0011See the full diff
    • ●

      added the new partner_grant_reward enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value partner_grant_reward to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

  • d629b0d5d83911See the full diff
    • ●

      added the new economic_intelligence_percentage_fee enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value economic_intelligence_percentage_fee to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

  • ef86d14ef6911See the full diff
    • ○

      added the new enum value hour to the query request parameter group_by

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ff3a765735632See the full diff
    • ●

      added the new psp_pool_refund_clearing enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new psp_pool_refund_settlement enum value to the // response property for the response status

      response-property-enum-value-added

  • c19acf2e254872See the full diff
    • ●

      added the new cashback enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new cashback_expense enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new cashback_funding enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new trading_account_deposit enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new trading_account_deposit_offset enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new trading_account_withdrawal enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new trading_account_withdrawal_offset enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value cashback to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value cashback_funding to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1660b8d622041See the full diff
    • ○

      added the enum value account_settlement to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a25564a92d532See the full diff
    • ●

      added the new platform_markup_fee enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new platform_markup_fee_payout enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new psp_fx_adjustment enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value platform_markup_fee to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value platform_markup_fee_payout to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8473fa1d1f472See the full diff
    • ●

      added the new operational_costs enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new settlement_shortfall_loss enum value to the // response property for the response status

      response-property-enum-value-added

  • 697924df40d111See the full diff
    • ●

      added the new onboarding_reward enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value onboarding_reward to the property items/ of the query request parameter line_types

      request-parameter-property-enum-value-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.