Documentation
void_by_filter
void_by_filter MCP tool reference, parameters, return type, and safety hints.
What it does
Voids or hard-deletes transactions matching a filter, with dry-run enabled by default.
(date_from?: string | null, date_to?: string | null, account_id?: string | null, status?: string | null, asset_id?: string | null, posted_at_from?: string | null, posted_at_to?: string | null, dry_run?: boolean, hard_delete?: boolean, sample_limit?: number | null) => Record<string, unknown>Destructive. This can remove, void, discard, roll back, repair, or permanently change ledger data. Require explicit user approval.
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.
Start with dry_run=true, show the preview, then ask before applying the change.
Create or confirm a backup and get explicit approval before running it for real.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
date_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nullaccount_idoptionalLedger account id or resolvable account reference.
Default: nullstatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nullposted_at_fromoptionalInput used by this tool.
Default: nullposted_at_tooptionalInput used by this tool.
Default: nulldry_runoptionalPreview the result without committing changes.
Default: truehard_deleteoptionalPermanently deletes rows instead of voiding them. Use only with explicit approval.
Default: falsesample_limitoptionalNumeric value used by this workflow.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
void_by_filter
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "void_by_filter",
"arguments": {
"dry_run": true
}
}