Skip to main content
GET
/
financial_reports
Get Financial Report
curl --request GET \
  --url https://{defaultHost}/financial_reports \
  --header 'Authorization: Bearer <token>'
{
  "report_type": "<string>",
  "rows": [
    {
      "period": "<string>",
      "grouping": "<string>",
      "line_category": "<string>",
      "amount": 123,
      "account_type": "<string>",
      "account_name": "<string>",
      "account_ik_path": "<string>",
      "line_count": 123
    }
  ],
  "total": 123,
  "beginning_balance": 123,
  "ending_balance": 123,
  "fx_excluded_currencies": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

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
integer

Start of the report window as a Unix timestamp (seconds, UTC). Required for platform-wide (global) reports.

​
to_date
integer

End of the report window as a Unix timestamp (seconds, UTC). Required for platform-wide (global) reports.

​
group_by
enum<string>
default:month

Grouping granularity for report rows.

Available options:
day,
week,
month
​
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[]