Documentation

refresh_statement

refresh_statement MCP tool reference, parameters, return type, and safety hints.

What it does

Refreshes statement in the local Clovis ledger.

Signature

(action?: string, plan_id?: string | null, file_path?: string | null, account_id?: string | null, counterpart_account_id?: string | null, expected_balance?: number | null, currency?: string | null, asset_id?: string | null, date_col?: string | null, amount_col?: string | null, desc_col?: string | null, inflow_col?: string | null, outflow_col?: string | null, counterpart_col?: string | null, tag_cols?: Record<string, unknown> | null, skip_rows?: number, skip_footer_rows?: number, date_format?: string, amount_convention?: string, statement_type?: string | null, balance_sign?: string | null, date_tolerance_days?: number, row_indexes?: number[] | null, pending_transactions?: Array<Record<string, unknown>> | null, void_stale_pending?: boolean, status?: string, dry_run?: boolean, batch_label?: string | null, sample_limit?: number, include_details?: boolean, verbosity?: string | null) => Record<string, unknown>

can writedry-run

Can write, but supports dry-run. Ask the agent to preview the result before committing changes.

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 prepare a change and show a preview before committing it.

Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows.

Use it only for local files the user has intentionally made available to Clovis.

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.

Confirm the file path, permissions, and whether the agent is allowed to read or write that location.

Start with dry_run=true, show the preview, then ask before applying the change.

State the intended ledger change in plain language before calling the tool.

Parameters

Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.

actionoptional

string

Input used by this tool.

Default: "plan"

plan_idoptional

string | null

Previously generated plan id.

Default: null

file_pathoptional

string | null

Local file path made available to Clovis.

Default: null

account_idoptional

string | null

Ledger account id or resolvable account reference.

Default: null

counterpart_account_idoptional

string | null

Offsetting account used for imported rows or generated transactions.

Default: null

expected_balanceoptional

number | null

Statement ending balance expected after reconciliation.

Default: null

currencyoptional

string | null

Currency symbol when the file or workflow needs an explicit currency.

Default: null

asset_idoptional

string | null

Asset or currency id used by the ledger.

Default: null

date_coloptional

string | null

Statement column containing transaction dates.

Default: null

amount_coloptional

string | null

Statement column containing signed amounts.

Default: null

desc_coloptional

string | null

Statement column containing merchant or transaction descriptions.

Default: null

inflow_coloptional

string | null

Statement column containing incoming amounts.

Default: null

outflow_coloptional

string | null

Statement column containing outgoing amounts.

Default: null

counterpart_coloptional

string | null

Statement column that maps rows to counterpart accounts.

Default: null

tag_colsoptional

object | null

Mapping of statement columns to tags.

Default: null

skip_rowsoptional

integer

Number of header rows to ignore at the start of a statement file.

Default: 0

skip_footer_rowsoptional

integer

Number of footer rows to ignore at the end of a statement file.

Default: 0

date_formatoptional

string

Statement date parser format, or auto for automatic parsing.

Default: "auto"

amount_conventionoptional

string

How statement amounts should be interpreted, such as signed or inflow/outflow.

Default: "signed"

statement_typeoptional

string | null

Optional statement type hint, such as checking, credit card, or brokerage.

Default: null

balance_signoptional

string | null

Input used by this tool.

Default: null

date_tolerance_daysoptional

integer

Number of days a candidate match may differ by.

Default: 3

row_indexesoptional

integer[] | null

Statement row indexes to apply or inspect.

Default: null

pending_transactionsoptional

object[] | null

Input used by this tool.

Default: null

void_stale_pendingoptional

boolean

Boolean switch for this workflow.

Default: false

statusoptional

string

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

Default: "posted"

dry_runoptional

boolean

Preview the result without committing changes.

Default: true

batch_labeloptional

string | null

Human label attached to the generated batch.

Default: null

sample_limitoptional

integer

Numeric value used by this workflow.

Default: 20

include_detailsoptional

boolean

Boolean switch for this workflow.

Default: false

verbosityoptional

string | null

Input used by this tool.

Default: null

Agent call shape

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