Sign in
Financial Timeline

Get timeline

Aggregated account characteristics are accumulated for all accounts of this user.

get/rest/timeline

Query parameters

sinceSchema — unresolved $ref

Limit the transactions included in the aggregation to have a booking date newer than including this date. If not specified the booking date of the oldest transaction is used instead. The format can be either YYYY, YYYY-mm or YYYY-mm-dd.

untilSchema — unresolved $ref

Limit the transactions included in the aggregation to have a booking date older than including this date. If not specified the current date is used. The format can be either YYYY, YYYY-mm or YYYY-mm-dd.

frequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'

Defines the frequency that is being used for sampling the data points.

currencystring

Filters the transactions used for aggregation based on their currency. Transactions in different currencies cannot be accumulated in a meaningful way.

accessesstring

Comma-separated list of access IDs. Only transactions belonging to accounts of these accesses will be selected.

accountsstring

Comma-separated list of account IDs. Only transactions belonging to these accounts will be selected.

categoriesstring

Comma-separated list of category IDs. Only transactions matching these categories will be selected.

payment_partnersstring

Comma-separated list of payment partner IDs. Only transactions corresponding to these payment partners will be selected.

Response

Transaction timeline.

periodstring required

Identifies the period for which the values are aggregated. The format depends on the frequency that has been specified in the request. Available formats are

  • YYYY yearly (e.g. 2019)
  • YYYY-mm monthly (e.g. 2019-12)
  • YYYY-Qq quarterly (e.g. 2019-Q1): Q is the literal character "Q" and q refers to the annual quarter.
  • YYYY-Ww weekly (e.g. 2019-W23): W is the literal character "W" and w refers to the ISO week number.
  • YYYY-mm-dd (e.g. 2019-12-24)
cashflownumber float required

Sum of expenses and deposits for the given period.

balancenumber float required

Running balance at the end of the given period.

Example response

[
  {
    "period": "2019-12",
    "cashflow": 2787.75,
    "balance": 10235.38,
    "expenses": {
      "href": "https://api.nrich.qwist.cloud/rest/transactions?amount_lt=0&since=2020-01-01&until=2020-01-31",
      "count": 29,
      "total": -1412.25,
      "low": -0.2,
      "high": -1200
    },
    "deposits": {
      "href": "https://api.nrich.qwist.cloud/rest/transactions?amount_gte=0&since=2020-01-01&until=2020-01-31",
      "count": 6,
      "total": 4200,
      "low": 380.5,
      "high": 3200.13
    },
    "transactions": {
      "href": "https://api.nrich.qwist.cloud/rest/transactions?since=2020-01-01&until=2020-01-31",
      "count": 35,
      "total": 2787.75,
      "low": -1200,
      "high": 3200.13
    }
  }
]