cash_flow

What it does

Reports cash flow in the local Clovis ledger.

Signature

(year: number, month: number, branch?: string | null, compact?: boolean, include_pending?: boolean, status?: string, quote_asset_id: string) => Record<string, unknown>

read-only

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.

Use it when an agent needs to inspect the ledger or answer a question without changing records.

Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning.

Before calling

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: year, month, quote_asset_id.

2

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.

yearrequired

integer

Four-digit year.

monthrequired

integer

Month number from 1 to 12.

branchoptional

string | null

Scenario branch name or id.

Default: null

compactoptional

boolean

Returns a smaller response shape when true.

Default: false

include_pendingoptional

boolean

Includes pending transactions in the calculation.

Default: false

statusoptional

string

Transaction status filter or value: posted, pending, planned, or void.

Default: "posted"

quote_asset_idrequired

string

Asset or currency used to quote report values. Clovis does not infer this.

Agent call shape

Use the exact tool name and pass arguments as structured JSON through the MCP client.

Copy this shape into agent instructions, evals, or MCP client tests.

{
  "tool": "cash_flow",
  "arguments": {
    "year": 1,
    "month": 6,
    "quote_asset_id": "USD"
  }
}

Metadata

CategoryPlanning and cash flow

ReturnsobjectReturns object from the local ledger.

Aliasescurrency -> quote_asset_id, quote -> quote_asset_id, quote_id -> quote_asset_id