Models

RuleStore

object

titlestringrequired

Example

First rule title.

descriptionstring

Example

First rule description

rule_group_idstringrequired

ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.

Example

rule_group_titlestring

Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory.

Example

New rule group

orderinteger<int32>

Example

triggerRuleTriggerTypestore-journalupdate-journalmanual-activationrequired

Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation.

Example

store-journal

activebooleantrue

Whether or not the rule is even active. Default is true.

Example

true

strictbooleantrue

If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.

Example

true

stop_processingboolean

If this value is true and the rule is triggered, other rules after this one in the group will be skipped. Default value is false.

Example

false

triggersArray<RuleTriggerStore>required

Show child attributes

typeRuleTriggerKeywordfrom_account_startsfrom_account_endsfrom_account_isfrom_account_containsto_account_startsto_account_endsto_account_isto_account_containsamount_lessamount_exactlyamount_moredescription_startsdescription_endsdescription_containsdescription_istransaction_typecategory_isbudget_istag_iscurrency_ishas_attachmentshas_no_categoryhas_any_categoryhas_no_budgethas_any_budgethas_no_taghas_any_tagnotes_containsnotes_startsnotes_endnotes_areno_notesany_notessource_account_isdestination_account_issource_account_startsrequired

The type of thing this trigger responds to. A limited set is possible

Example

user_action

valuestringrequired

The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger.

Example

tag1

orderinteger<int32>

Order of the trigger

Example

activebooleantrue

If the trigger is active. Defaults to true.

Example

true

prohibitedbooleanfalse

If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc.

Example

false

stop_processingbooleanfalse

When true, other triggers will not be checked if this trigger was triggered. Defaults to false.

Example

false

actionsArray<RuleActionStore>required

Show child attributes

typeRuleActionKeyworduser_actionset_categoryclear_categoryset_budgetclear_budgetadd_tagremove_tagremove_all_tagsset_descriptionappend_descriptionprepend_descriptionset_source_accountset_destination_accountset_notesappend_notesprepend_notesclear_noteslink_to_billconvert_withdrawalconvert_depositconvert_transferdelete_transactionrequired

The type of thing this action will do. A limited set is possible.

Example

set_category

valuestring | nullrequired

The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory.

Example

Daily groceries

orderinteger<int32>

Order of the action

Example

activebooleantrue

If the action is active. Defaults to true.

Example

true

stop_processingbooleanfalse

When true, other actions will not be fired after this action has fired. Defaults to false.

Example

false

Example

{
  "title": "First rule title.",
  "description": "First rule description",
  "rule_group_id": "81",
  "rule_group_title": "New rule group",
  "order": 5,
  "trigger": "store-journal",
  "active": true,
  "strict": true,
  "stop_processing": false,
  "triggers": [
    {
      "type": "user_action",
      "value": "tag1",
      "order": 5,
      "active": true,
      "prohibited": false,
      "stop_processing": false
    }
  ],
  "actions": [
    {
      "type": "set_category",
      "value": "Daily groceries",
      "order": 5,
      "active": true,
      "stop_processing": false
    }
  ]
}