v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Financial Statements

Get Cash Basis Operating Statement

get/ca/api/cash-basis-operating-statement

Query parameters

all_timeboolean

If true, uses full transaction date range for the customer; start_date and end_date are ignored

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

export'xlsx'

If xlsx, returns Excel file (income_statement.xlsx) instead of JSON

groupinteger

Tag group ID. Required when group_by=tag

group_bystring

Breakdown dimension: vendor, department, tag, currency, entity. For tag, also pass group (tag group ID). For cash-basis, department_row_children, department_row_parents, department_only normalize to department

rollup_totalsboolean

If true, roll up child account totals to parent accounts. Set to false for export

start_datestring date

Earliest date (inclusive) for which to retrieve data. Defaults to six months ago

Response

No response body