Balance Sheet
balance_sheetFull Description
Generate balance sheet for a specified period and cadence. Dates must be YYYY-MM-DD. Can be filtered to specific departments, accounts and tags.
Parameters (0 required, 10 optional)
account_idsarrayRestrict the report to these account IDs. Call get_accounts() to discover IDs — filter it by account_type (e.g. OPERATING_EXPENSES, COGS) or account_subtype to find the accounts that make up a category.
nullcadencestringReporting cadence (case-insensitive). Valid values: monthly, quarterly, yearly.
nulldate_fromstringStart date of the period. Must be YYYY-MM-DD (e.g. 2024-01-01). Do not pass a year only (e.g. 2024); use full date.
nulldate_tostringEnd date of the period. Must be YYYY-MM-DD (e.g. 2024-12-31). Do not pass a year only (e.g. 2024); use full date.
nulldepartment_idsarrayRestrict the report to these department IDs. Call get_departments() to discover IDs. This narrows the report; it is not the same as group_by='department', which keeps every department and breaks them out into separate columns.
nullentity_idintegerEntity ID for the report. Omit for default.
nullgroup_bystringDimension to group results by. Valid values: vendor, department, tag, currency, entity. When group_by='tag', you MUST also pass tag_group_name (e.g. 'Location'); call get_tags(groups_only=true) first to discover the available tag groups for this customer.
nullno_departmentbooleanIf true, restrict the report to activity with no department assigned. Combine with department_ids to include unassigned activity alongside named departments. Supported by income_statement only.
Falsetag_group_namestringRequired when group_by='tag'. Names the TransactionTagGroup to pivot on, e.g. 'Location'. Case-insensitive. Ignored for other breakdowns. Call get_tags(groups_only=true) to discover the available tag groups.
nulltag_idsarrayRestrict the report to these tag IDs. Call get_tags() to discover IDs. This filters the report; it is distinct from tag_group_name, which pivots columns by tag group.
null