v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Financial Statements

Get Balance Sheet

Returns ending account balances for each period between start_date and end_date (both inclusive), split by cadence. This is the recommended endpoint for balance sheet ending balances.

How the date range works: start_date is not the date balances are calculated from. Account balances are always accumulated from the beginning of time through each period end. start_date, end_date, and cadence only determine how the report is split into periods (columns).

Retained earnings: included as its own row.

Breakdowns: the report can be broken down or filtered by entity, department, and tag dimensions via group_by (pass group with a tag group ID when grouping by tag).

get/ca/api/get_balance_sheet

Query parameters

cadence'daily' | 'monthly' | 'quarterly' | 'weekly' | 'yearly'
end_datestring date

Latest date (inclusive) for which to retrieve data. Defaults to end of current month

entityinteger

Entity ID(s) to scope the report. Can be repeated (?entity=1&entity=2) or JSON array

entity_rollupboolean

If true, includes all data of children entities in consolidation

group_bystring
start_datestring date

Earliest period (inclusive) shown in the report. NOTE: balances are NOT calculated starting from this date - account balances are always accumulated from the beginning of time through each period end. start_date, end_date, and cadence only control how the report is split into periods (columns). Defaults to six months ago.

Response

start_datestring date
end_datestring date
cadencestring
headersobject