getBalanceSheet
getBalanceSheetRetrieve a balance sheet report detailing assets, liabilities, and equity. Scope to a specific customer, contract, or GL account with optional currency and cadence settings.
Instructions
Retrieve the balance sheet report (assets, liabilities, equity). Supports per-customer / per-contract / per-account scoping via filters and currency / cadence selection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| start_date | No | Start date for the balance sheet period (YYYY-MM-DD). | |
| end_date | No | End date for the balance sheet period (YYYY-MM-DD). Defaults to today. | |
| cadence | No | Bucket cadence for the report. One of 'month', 'quarter', 'year'. Defaults to 'month'. | |
| currency | No | Three-letter ISO currency code to scope the report (e.g. 'USD'). | |
| customer_id | No | Restrict report to a single customer UUID. | |
| contract_id | No | Restrict report to a single billing contract UUID (enables per-contract balance sheet). | |
| account_id__in | No | Filter to a list of GL account UUIDs. | |
| grouping_keys | No | Optional grouping dimensions, e.g. ['customer_id'] or ['contract_id']. | |
| get_changes | No | If true, return period-over-period changes instead of cumulative values. | |
| cursor | No | Cursor for pagination. | |
| limit | No | Maximum rows per page (default 10). | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |