Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

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.

from_datestring

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

to_datestring

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

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

Grouping granularity for report rows.

timezonestring

IANA timezone (for example America/New_York) used to bucket report periods and to interpret calendar-day boundaries for balance snapshots. Defaults to UTC. from_date/to_date remain exact instants regardless of this setting.

cumulativeboolean

Platform-wide (global) reports only: when true, return cumulative balances as of to_date (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.

Response

financial report returned

beginning_balancenumber nullable
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,
  "ending_balance": 23750.55,
  "fx_excluded_currencies": [
    "ngn"
  ],
  "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
}