Documentation
income_statement
income_statement MCP tool reference, parameters, return type, and safety hints.
What it does
Builds income statement in the local Clovis ledger.
(year: number, month?: number | null, branch?: string | null, compact?: boolean, include_pending?: boolean, account_ids?: string[] | null, entity_id?: string | null, quote_asset_id: string, status?: 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: year, 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.
yearrequiredFour-digit year.
monthoptionalMonth number from 1 to 12.
Default: nullbranchoptionalScenario branch name or id.
Default: nullcompactoptionalReturns a smaller response shape when true.
Default: falseinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: falseaccount_idsoptionalList of ledger account ids or account references.
Default: nullentity_idoptionalEntity id to filter reports when entity tracking is used.
Default: nullquote_asset_idrequiredAsset or currency used to quote report values. Clovis does not infer this.
statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
income_statement
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "income_statement",
"arguments": {
"year": 1,
"quote_asset_id": "USD"
}
}