Preview what the rules would change
preview_rule_effectsPreview how budget rules would modify existing transactions without saving, showing field changes before applying them.
Instructions
Run the budget’s rules over EXISTING transactions without saving anything, and report the field changes they would make. Actual applies rules on import and edit only, so transactions already in the budget are untouched until you act on them — this shows what a rule would have done to them. The usual flow is create_rule, then this to check it against real data, then apply_rule_actions to make the changes stick.
IMPORTANT: this reports the net effect of the ENTIRE rule set, not one rule in isolation. Actual has no per-rule preview, and rules interact by rank, so a change shown here may come from a rule other than the one you just wrote. Verify against list_rules before assuming which rule caused it.
Each change gives from/to as readable names plus fromId/toId for the fields that hold ids — pass toId as the action value to apply_rule_actions. Transactions the rules would not change are omitted, so an empty entries with a non-zero scanned means the rules are a no-op here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many transactions to scan. Default 100. | |
| dateTo | No | Only transactions on or before this date (YYYY-MM-DD). | |
| offset | No | How many matching transactions to skip, for paging past `limit`. Keep the other filters identical. | |
| payeeId | No | Restrict to one payee. | |
| dateFrom | No | Only transactions on or after this date (YYYY-MM-DD). | |
| accountId | No | Restrict to one account. | |
| categoryId | No | Restrict to one category. | |
| notesContains | No | Substring match against notes. | |
| uncategorized | No | Only transactions with no category — the usual cleanup target. | |
| payeeNameContains | No | Substring match against the payee name. |