Sign in
rule_groups

Test which transactions would be hit by the rule group. No changes will be made.

Test which transactions would be hit by the rule group. No changes will be made. Limit the result if you want to.

get/v1/rule-groups/{id}/test

Path parameters

idstring required
Example:123

The ID of the rule group.

Query parameters

limitinteger
Example:10

Number of items per page. The default pagination is per 50 items.

pageinteger
Example:1

Page number. The default pagination is per 50 items.

startstring date
Example:2026-08-01

A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.

endstring date
Example:2026-08-31

A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.

search_limitinteger

Maximum number of transactions Firefly III will try. Don't set this too high, or it will take Firefly III very long to run the test. I suggest a max of 200.

triggered_limitinteger

Maximum number of transactions the rule group can actually trigger on, before Firefly III stops. I would suggest setting this to 10 or 15. Don't go above the user's page size, because browsing to page 2 or 3 of a test result would fire the test again, making any navigation efforts very slow.

accounts[]integer[]

Limit the testing of the rule group to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.

[
  1,
  2,
  3
]

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of transactions that would be changed by any of the rules of the rule group. No changes will be made.

Changes

No recorded changes to this endpoint across all 1 revision of this API.