v8

OpenAPI 3.1.02026-08-033623795.0 MB

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