This is definitely not functional yet. Signed-off-by: Jacob Kiers <code@kiers.eu>
11 KiB
\RuleGroupsApi
All URIs are relative to https://demo.firefly-iii.org/api
Method | HTTP request | Description |
---|---|---|
delete_rule_group | DELETE /v1/rule-groups/{id} | Delete a rule group. |
fire_rule_group | POST /v1/rule-groups/{id}/trigger | Fire the rule group on your transactions. |
get_rule_group | GET /v1/rule-groups/{id} | Get a single rule group. |
list_rule_by_group | GET /v1/rule-groups/{id}/rules | List rules in this rule group. |
list_rule_group | GET /v1/rule-groups | List all rule groups. |
store_rule_group | POST /v1/rule-groups | Store a new rule group. |
test_rule_group | GET /v1/rule-groups/{id}/test | Test which transactions would be hit by the rule group. No changes will be made. |
update_rule_group | PUT /v1/rule-groups/{id} | Update existing rule group. |
delete_rule_group
delete_rule_group(id, x_trace_id) Delete a rule group.
Delete a rule group.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. |
Return type
(empty response body)
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
fire_rule_group
fire_rule_group(id, x_trace_id, start, end, accounts_left_square_bracket_right_square_bracket) Fire the rule group on your transactions.
Fire the rule group on your transactions. Changes will be made by the rules in the rule group! Limit the result if you want to.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. | ||
start | Option<String> | A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present. | ||
end | Option<String> | A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present. | ||
accounts_left_square_bracket_right_square_bracket | Option<Vec> | Limit the triggering of the rule group to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped. |
Return type
(empty response body)
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_rule_group
models::RuleGroupSingle get_rule_group(id, x_trace_id) Get a single rule group.
Get a single rule group. This does not include the rules. For that, see below.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list_rule_by_group
models::RuleArray list_rule_by_group(id, x_trace_id, limit, page) List rules in this rule group.
List rules in this rule group.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. | ||
limit | Option<i32> | Number of items per page. The default pagination is per 50 items. | ||
page | Option<i32> | Page number. The default pagination is per 50 items. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list_rule_group
models::RuleGroupArray list_rule_group(x_trace_id, limit, page) List all rule groups.
List all rule groups.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. | ||
limit | Option<i32> | Number of items per page. The default pagination is per 50 items. | ||
page | Option<i32> | Page number. The default pagination is per 50 items. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
store_rule_group
models::RuleGroupSingle store_rule_group(rule_group_store, x_trace_id) Store a new rule group.
Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
rule_group_store | RuleGroupStore | JSON array or key=value pairs with the necessary rule group information. See the model for the exact specifications. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_rule_group
models::TransactionArray test_rule_group(id, x_trace_id, limit, page, start, end, search_limit, triggered_limit, accounts_left_square_bracket_right_square_bracket) 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.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. | ||
limit | Option<i32> | Number of items per page. The default pagination is per 50 items. | ||
page | Option<i32> | Page number. The default pagination is per 50 items. | ||
start | Option<String> | 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. | ||
end | Option<String> | 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_limit | Option<i32> | 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_limit | Option<i32> | 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_left_square_bracket_right_square_bracket | Option<Vec> | 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. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_rule_group
models::RuleGroupSingle update_rule_group(id, rule_group_update, x_trace_id) Update existing rule group.
Update existing rule group.
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
id | String | The ID of the rule group. | [required] | |
rule_group_update | RuleGroupUpdate | JSON array with updated rule group information. See the model for the exact specifications. | [required] | |
x_trace_id | Option<uuid::Uuid> | Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]