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

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

get/v1/rules/{id}/test

Path parameters

idstring required

Example:123

The ID of the rule.

Query parameters

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.

accounts[]integer[]

Limit the testing of the rule 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 the rule. No changes will be made.

Changes

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