Skip to content
Patrimoine
v9.1.0

Read Alert Rules

GET
/api/v1/alert-rules
curl --request GET \
  --url https://example.com/api/v1/alert-rules

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AlertRulesOut

The user’s three rules, defaults filled in for any rule never saved.

object
budget_overspent
required
BudgetOverspentRule

Fires when a category’s month-to-date spending reaches percent, and again at percent2 when set, of its monthly budget: once per category per month for each level. percent2 must be sent and is null for a single level. category_id null means every category with a budget.

object
enabled
required
Enabled
boolean
category_id
Any of:
integer
percent
required
Percent
integer
>= 1 <= 200
percent2
required
Any of:
integer
>= 1 <= 200
bill_due
required
BillDueRule

Fires once per due date for a manual planned item due within days days, or overdue.

object
enabled
required
Enabled
boolean
days
required
Days
integer
<= 30
stale_snapshot
required
StaleSnapshotRule

Fires when an account’s latest snapshot is older than days. account_id null means every account.

object
enabled
required
Enabled
boolean
days
required
Days
integer
>= 1 <= 365
account_id
Any of:
integer

Example generated

{
  "budget_overspent": {
    "enabled": true,
    "category_id": 1,
    "percent": 1,
    "percent2": 1
  },
  "bill_due": {
    "enabled": true,
    "days": 1
  },
  "stale_snapshot": {
    "enabled": true,
    "days": 1,
    "account_id": 1
  }
}