Sign in
Events

List events in scenario.

Lists events belonging to a scenario by their ID.

get/scenarios/{id}/events

Path parameters

idinteger required

The unique identifier of the scenario.

Query parameters

start_datestring required

Return the events from and including this date.

end_datestring required

Return the events until and including this date.

Response

Success

idstring

The unique identifier of the event.

amountnumber

The amount of the event.

amount_in_base_currencynumber

The amount of the event in the user's base currency.

currency_codestring

The currency code of the event.

datestring

The date of the event.

colourstring

The CSS hex-style colour of the event.

notestring

The note of the event.

repeat_type'once' | 'daily' | 'weekly' | 'fortnightly' | 'monthly' | 'yearly' | 'each weekday'

The repeat type of the event.

repeat_intervalinteger

The repeat interval of how often the event takes place.

series_idinteger

The unique identifier of the series that the event belongs to.

series_start_idstring

The unique identifier of the series followed by the series's start date.

infinite_seriesboolean

Whether the event repeats and does not have an end date.

Example response

[
  {
    "id": "42-1601942400",
    "category": {
      "id": 1438154,
      "title": "Beer",
      "colour": "#00ff00",
      "parent_id": 42,
      "is_bill": true,
      "refund_behaviour": "credits_are_refunds",
      "created_at": "2015-08-16T02:17:02Z",
      "updated_at": "2015-08-16T02:17:02Z"
    },
    "scenario": {
      "id": 42,
      "title": "Wedding",
      "interest_rate": 2.4,
      "interest_rate_repeat_id": 4,
      "type": "no-interest",
      "minimum-value": 4000,
      "maximum-value": 42,
      "starting_balance": 2450,
      "starting_balance_date": "2018-02-27",
      "closing_balance": 5431.2,
      "closing_balance_date": "2018-02-27",
      "current_balance": 5431.2,
      "current_balance_date": "2018-02-27",
      "current_balance_in_base_currency": 8146.8,
      "current_balance_exchange_rate": 1.5,
      "safe_balance": 5431.2,
      "safe_balance_in_base_currency": 8146.8,
      "created_at": "2015-04-21T22:42:22Z",
      "updated_at": "2015-04-21T22:42:22Z"
    },
    "amount": 250.5,
    "amount_in_base_currency": 375.75,
    "currency_code": "nzd",
    "date": "2020-10-27",
    "colour": "#F63737",
    "note": "Buy more beer every Friday from the local brewery.",
    "repeat_type": "weekly",
    "repeat_interval": 1,
    "series_id": 42,
    "series_start_id": "42-1593993600",
    "infinite_series": true
  }
]

Changes