FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

Rules & Groups API → Test Rule

AI-generated

Overview

This node operation tests a specific rule within the FireFly III Rules & Groups API. It allows users to validate how a rule would apply to transactions within a specified date range and optionally filtered by account IDs. This is useful for debugging and verifying rule logic before applying it in production.

Use Case Examples

  1. A user wants to test a rule that categorizes transactions based on certain criteria. They specify the rule ID, a date range for transactions to test against, and optionally filter by account IDs to see which transactions match the rule.
  2. Another scenario is when a user has created a complex rule and wants to ensure it triggers correctly on historical data before enabling it for automatic processing.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Rule/Group ID The ID of the rule to test. This is required to specify which rule the test operation will run against.
Date Range Filters Filters specifying the start and end dates for testing transactions against the rule. This is required to limit the scope of transactions considered in the test.
Account IDs Comma-separated list of account IDs to filter transactions by during the test. Optional to narrow down the test scope to specific accounts.

Output

JSON

  • json - The JSON response from the FireFly III API containing the results of the rule test, including matched transactions and rule evaluation details.

Dependencies

  • FireFly III API with appropriate OAuth2 credentials

Troubleshooting

  • Ensure the Rule/Group ID is valid and exists in the FireFly III system; otherwise, the API will return an error.
  • Date Range Filters must include a valid start date; missing or incorrectly formatted dates may cause the request to fail.
  • If filtering by Account IDs, ensure the IDs are correctly formatted as a comma-separated string without spaces.
  • Check the X-Trace-ID if debugging request issues; it should be a valid UUID format.

Links

Discussion