Sign in

v1

latestOpenAPI 3.0.12026-07-135618141.0 KB
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.