Skip to main content
GET
Get Financial Report

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

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_activity,
income_statement,
balance_summary
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_date
string

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

to_date
string

End of the report window as an ISO 8601 timestamp (UTC). 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 and to interpret calendar-day boundaries for balance snapshots. Defaults to UTC. from_date/to_date remain exact instants regardless of this setting. Platform-wide (global) reports are UTC-only and reject other timezones.

cumulative
boolean
default:false

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_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.

Response

financial report returned

report_type
string
required
rows
object[]
required
total
number
required
beginning_balance
number | null
ending_balance
number | null
fx_excluded_currencies
string[]