FireFly III icon

FireFly III

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

Actions89

Rules & Groups API → Test Rule Group

AI-generated

Overview

This node operation tests a specific rule group in the FireFly III system by querying transactions within a specified date range and applying optional filters such as account IDs and test limits. It is useful for validating the behavior of rule groups against historical transaction data before applying them in production.

Use Case Examples

  1. Testing a rule group to see which transactions it would trigger within the last 30 days for specific accounts.
  2. Validating the effectiveness of a rule group by limiting the number of transactions searched and triggered during the test.

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 or group to operate on.
Date Range Filters Filters specifying the start and end dates for testing transactions (YYYY-MM-DD).
Account IDs Comma-separated list of account IDs to filter the transactions for testing.
Test Limits Limits to control the maximum number of transactions to search and trigger during the test.

Output

JSON

  • json - The JSON response from the FireFly III API containing the test results of the rule group.

Dependencies

  • FireFly III API with appropriate OAuth2 credentials

Troubleshooting

  • Ensure the Rule/Group ID is valid and exists in the FireFly III system to avoid errors.
  • Verify that the date range filters are correctly formatted as YYYY-MM-DD and that the start date is before the end date.
  • Check that the account IDs provided are valid and accessible by the authenticated user.
  • Avoid setting excessively high search limits to prevent long execution times or timeouts.

Links

Discussion