Documentation
account_balances
account_balances MCP tool reference, parameters, return type, and safety hints.
What it does
Shows posted, pending, and current balances by account and asset.
(account_type?: string | null, asset_id?: string | null, as_of?: string | null, rollup?: boolean, hide_zero?: boolean, native_asset_only?: boolean, presentation?: string, account_ids?: string[] | null, entity_id?: string | null) => Array<Record<string, unknown>>Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.
When to use it
Use this section to decide whether the tool fits the user request before calling it.
Before calling
Agents should gather these facts or confirmations first.
No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
account_typeoptionalAccount type filter, such as asset, liability, equity, income, or expense.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nullas_ofoptionalDate to calculate balances through, usually YYYY-MM-DD.
Default: nullrollupoptionalBoolean switch for this workflow.
Default: falsehide_zerooptionalHides zero-balance rows from the response.
Default: truenative_asset_onlyoptionalCurrency or asset symbol/id.
Default: falsepresentationoptionalInput used by this tool.
Default: "ledger"account_idsoptionalList of ledger account ids or account references.
Default: nullentity_idoptionalEntity id to filter reports when entity tracking is used.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
account_balances
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "account_balances",
"arguments": {}
}