Documentation
balance_sheet
balance_sheet MCP tool reference, parameters, return type, and safety hints.
What it does
Builds an assets, liabilities, and equity report for a date or scenario branch.
(date?: string | null, branch?: string | null, compact?: boolean, include_pending?: boolean, status?: string, hide_zero?: boolean, quote_asset_id: string, account_ids?: string[] | null, entity_id?: string | null) => 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.
Have exact values for required inputs: quote_asset_id.
Choose the report currency or asset explicitly; Clovis does not infer report currency.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
dateoptionalLedger date in YYYY-MM-DD format.
Default: nullbranchoptionalScenario branch name or id.
Default: nullcompactoptionalReturns a smaller response shape when true.
Default: falseinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: truestatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "active"hide_zerooptionalHides zero-balance rows from the response.
Default: falsequote_asset_idrequiredAsset or currency used to quote report values. Clovis does not infer this.
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.
balance_sheet
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "balance_sheet",
"arguments": {
"quote_asset_id": "USD"
}
}