---
title: "Get timeline"
method: GET
path: "/rest/timeline"
tags: ["Financial Timeline"]
---

# Get timeline

`GET /rest/timeline`

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

## Query parameters

- `since` Schema — unresolved $ref
- `until` Schema — unresolved $ref
- `frequency` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'
- `currency` string
- `accesses` string
- `accounts` string
- `categories` string
- `payment_partners` string

## Response `200`

Transaction timeline.

- object[]
  - `period` string, 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)
  - `cashflow` number, float, required — Sum of expenses and deposits for the given period.
  - `balance` number, float, required — Running balance at the end of the given period.
  - `expenses` object, required — Expense characteristics for this period.
    - `href` string, uri, required — A link to the list of expenses for this period. The URL includes all required query parameters for filtering on the transactions endpoint.
    - `count` integer, required — Number of expenses.
    - `total` number, float, required — Total amount of expenses.
    - `low` number, float, required — Lowest expense for this period.
    - `high` number, float, required — Highest expense for this period.
  - `deposits` object, required — Deposit characteristics for this period.
    - `href` string, uri, required — A link to the list of deposits for this period. The URL includes all required query parameters for filtering on the transactions endpoint.
    - `count` integer, required — Number of deposits.
    - `total` number, float, required — Total amount of deposits.
    - `low` number, float, required — Lowest deposit for this period.
    - `high` number, float, required — Highest deposit for this period.
  - `transactions` object, required — Overall transaction characteristics for this period.
    - `href` string, uri, required — A link to the list of all transactions of this period.
    - `count` integer, required — Total number of transactions. This is the summed number of deposits and expenses.
    - `total` number, float, required — Total amount of transactions. This equals `cashflow` and appears here for structural consistency.
    - `low` number, float, required — Highest expense for this period. This equals `expenses.high` and appears here for structural consistency.
    - `high` number, float, required — Highest deposit for this period. This equals `deposits.high` and appears here for structural consistency.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)