Qwist Financial Timeline API

openapi: 3.2.0
info:
  title: nrich Financial Timeline API
  version: '2.10'
  contact:
    name: Qwist GmbH
    email: partnersupport@qwist.com
    url: https://qwist.com
  description: This is the reference for Qwist's nrich API
servers:
- url: https://api.nrich.qwist.cloud
  description: Staging environment
tags:
- name: Financial Timeline
paths:
  /rest/accesses/{access-id}/timeline:
    get:
      summary: Get timeline for access
      operationId: getTimelineForAccess
      description: Aggregated account characteristics are accumulated for all accounts of this access.
      tags:
      - Financial Timeline
      parameters:
      - $ref: '#/paths/~1rest~1accesses~1{access-id}/get/parameters/0'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/0'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/1'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/2'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/3'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/5'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/6'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/7'
      security:
      - user_auth: []
      responses:
        '200':
          $ref: '#/paths/~1rest~1timeline/get/responses/200'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
  /rest/accounts/{account-id}/timeline:
    get:
      summary: Get timeline for account
      operationId: getTimelineForAccount
      description: Aggregated account characteristics are calculated for a single account.
      tags:
      - Financial Timeline
      parameters:
      - $ref: '#/paths/~1rest~1accounts~1{account-id}/get/parameters/0'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/0'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/1'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/2'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/6'
      - $ref: '#/paths/~1rest~1timeline/get/parameters/7'
      security:
      - user_auth: []
      responses:
        '200':
          $ref: '#/paths/~1rest~1timeline/get/responses/200'
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
  /rest/timeline:
    get:
      summary: Get timeline
      operationId: getTimeline
      description: Aggregated account characteristics are accumulated for all accounts of this user.
      tags:
      - Financial Timeline
      parameters:
      - in: query
        name: since
        schema:
          $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
        description: 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`.
        example: 2019-12
      - in: query
        name: until
        schema:
          $ref: '#/paths/~1auth~1users/get/parameters/2/schema'
        description: 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`.
        example: 2020-02
      - in: query
        name: frequency
        schema:
          type: string
          enum:
          - daily
          - weekly
          - monthly
          - quarterly
          - yearly
          default: monthly
        description: Defines the frequency that is being used for sampling the data points.
        example: weekly
      - in: query
        name: currency
        schema:
          type: string
          default: EUR
        description: Filters the transactions used for aggregation based on their currency. Transactions in different currencies cannot be accumulated in a meaningful way.
      - in: query
        name: accesses
        schema:
          type: string
        description: Comma-separated list of access IDs. Only transactions belonging to accounts of these accesses will be selected.
        example: X1.1,X1.3
        explode: false
      - in: query
        name: accounts
        schema:
          type: string
        description: Comma-separated list of account IDs. Only transactions belonging to these accounts will be selected.
        example: A1.1,A1.3
        explode: false
      - in: query
        name: categories
        schema:
          type: string
        description: Comma-separated list of category IDs. Only transactions matching these categories will be selected.
        example: 12,56
        explode: false
      - in: query
        name: payment_partners
        schema:
          type: string
        description: Comma-separated list of payment partner IDs. Only transactions corresponding to these payment partners will be selected.
        example: e89887dc-3eec-42cf-92eb-c83c772d99fd
        explode: false
      security:
      - user_auth: []
      responses:
        '200':
          description: Transaction timeline.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    period:
                      type: string
                      example: 2019-12
                      description: "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\n\n  * `YYYY` yearly (e.g. 2019)\n  * `YYYY-mm` monthly (e.g. 2019-12)\n  * `YYYY-Qq` quarterly (e.g. 2019-Q1): `Q` is the literal character \"Q\" and `q` refers to the annual quarter.\n  * `YYYY-Ww` weekly (e.g. 2019-W23): `W` is the literal character \"W\" and `w` refers to the ISO week number.\n  * `YYYY-mm-dd` (e.g. 2019-12-24)"
                    cashflow:
                      type: number
                      format: float
                      example: 2787.75
                      description: Sum of expenses and deposits for the given period.
                    balance:
                      type: number
                      format: float
                      example: 10235.38
                      description: Running balance at the end of the given period.
                    expenses:
                      type: object
                      description: Expense characteristics for this period.
                      properties:
                        href:
                          type: string
                          format: uri
                          example: https://api.nrich.qwist.cloud/rest/transactions?amount_lt=0&since=2020-01-01&until=2020-01-31
                          description: A link to the list of expenses for this period. The URL includes all required query parameters for filtering on the transactions endpoint.
                        count:
                          type: integer
                          example: 29
                          description: Number of expenses.
                        total:
                          type: number
                          format: float
                          example: -1412.25
                          description: Total amount of expenses.
                        low:
                          type: number
                          format: float
                          example: -0.2
                          description: Lowest expense for this period.
                        high:
                          type: number
                          format: float
                          example: -1200
                          description: Highest expense for this period.
                      required:
                      - href
                      - count
                      - total
                      - low
                      - high
                    deposits:
                      type: object
                      description: Deposit characteristics for this period.
                      properties:
                        href:
                          type: string
                          format: uri
                          example: https://api.nrich.qwist.cloud/rest/transactions?amount_gte=0&since=2020-01-01&until=2020-01-31
                          description: A link to the list of deposits for this period. The URL includes all required query parameters for filtering on the transactions endpoint.
                        count:
                          type: integer
                          example: 6
                          description: Number of deposits.
                        total:
                          type: number
                          format: float
                          example: 4200
                          description: Total amount of deposits.
                        low:
                          type: number
                          format: float
                          example: 380.5
                          description: Lowest deposit for this period.
                        high:
                          type: number
                          format: float
                          example: 3200.13
                          description: Highest deposit for this period.
                      required:
                      - href
                      - count
                      - total
                      - low
                      - high
                    transactions:
                      type: object
                      description: Overall transaction characteristics for this period.
                      properties:
                        href:
                          type: string
                          format: uri
                          example: https://api.nrich.qwist.cloud/rest/transactions?since=2020-01-01&until=2020-01-31
                          description: A link to the list of all transactions of this period.
                        count:
                          type: integer
                          example: 35
                          description: Total number of transactions. This is the summed number of deposits and expenses.
                        total:
                          type: number
                          format: float
                          example: 2787.75
                          description: Total amount of transactions. This equals `cashflow` and appears here for structural consistency.
                        low:
                          type: number
                          format: float
                          example: -1200
                          description: Highest expense for this period. This equals `expenses.high` and appears here for structural consistency.
                        high:
                          type: number
                          format: float
                          example: 3200.13
                          description: Highest deposit for this period. This equals `deposits.high` and appears here for structural consistency.
                      required:
                      - href
                      - count
                      - total
                      - low
                      - high
                  required:
                  - period
                  - transactions
                  - expenses
                  - deposits
                  - cashflow
                  - balance
        '400':
          $ref: '#/paths/~1rest~1user/put/responses/400'
        '401':
          $ref: '#/paths/~1catalog/get/responses/401'
components:
  securitySchemes:
    user_auth:
      type: http
      description: 'In order to access any information belonging to a user, a client has to authenticate with a token linking itself to the user.  This token is called an `access token` and contains information on the client, the user and the level of access the client has to the users data. In order to authenticate using such an access token the HTTP header `Authorization` is set to `Bearer <access token>`. The  `access token` is formatted

        as a JSON Web Token according to [RFC7519](https://tools.ietf.org/html/rfc7519)


        Such an `access token` is either returned when


        * exchanging an authorization code after a successful OAuth login flow

        * logging in with the user''s credentials

        * exchanging a refresh token, which is returned at either of the aforementioned points


        **Authentication errors**


        In case of an authentication error a HTTP code 401 response is returned containing further

        details on the kind of error in the `WWW-Authenticate` header.


        In addition to the below listed scope the flags are used for simple boolean permissions.


        | Flag            | Description                                  |

        | --              | --                                           |

        | submit_payments | Allow submission of payments to bank server  |

        | offline         | Access finX API when the user is not present |

        | create_user     | Allow creation of finX accounts              |


        **Example**


        The string `"accounts=rw submit_payments"` is URL-encoded and passed as the URL

        parameter `scope`.'
      scheme: bearer
      bearerFormat: JWT
      x-bearerInfoFunc: app.decode_token
      x-scopes:
        accounts=rw: Modify accounts
        accounts=ro: Read accounts
        balance=ro: Read account balance
        securities=ro: Read securities
        transactions=ro: Read transactions
        transactions=rw: Modify transactions
        payments=ro: Read payments
        payments=rw: Create/modify payments
        submit_payments: Submit payment to service provider
        user=ro: Read user information
        user=rw: Modify user information
    client_auth:
      x-basicInfoFunc: app.basic_auth
      type: http
      scheme: basic
      description: Client authentication is performed via [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with client ID as username and client secret as password.
x-provenance:
  method: searched
  source: https://docs.qwist.com/reference
  harvested: '2026-10-21'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.qwist.com/reference/addprovideraccess.md
  - https://docs.qwist.com/reference/categorizetransactions.md
  - https://docs.qwist.com/reference/createaccesstoken.md
  - https://docs.qwist.com/reference/createaccountverification.md
  - https://docs.qwist.com/reference/createcontract.md
  - https://docs.qwist.com/reference/createincomereport.md
  - https://docs.qwist.com/reference/createmanualsync.md
  - https://docs.qwist.com/reference/createnotification.md
  - https://docs.qwist.com/reference/createonetimeaccess.md
  - https://docs.qwist.com/reference/createonetimeincomereport.md
  - https://docs.qwist.com/reference/createonetimepayment.md
  - https://docs.qwist.com/reference/createonetimeriskreport.md
  - https://docs.qwist.com/reference/createongoingaccess.md
  - https://docs.qwist.com/reference/createongoingpayment.md
  - https://docs.qwist.com/reference/createongoingriskreport.md
  - https://docs.qwist.com/reference/createpayment.md
  - https://docs.qwist.com/reference/createpaymentfromaccount.md
  - https://docs.qwist.com/reference/createqwistlink.md
  - https://docs.qwist.com/reference/createriskreport.md
  - https://docs.qwist.com/reference/createsync.md
  - https://docs.qwist.com/reference/createupload.md
  - https://docs.qwist.com/reference/createuser.md
  - https://docs.qwist.com/reference/createverifyandpay.md
  - https://docs.qwist.com/reference/deleteaccount.md
  - https://docs.qwist.com/reference/deleteclientuser.md
  - https://docs.qwist.com/reference/deletecontract.md
  - https://docs.qwist.com/reference/deletenotification.md
  - https://docs.qwist.com/reference/deletepayment.md
  - https://docs.qwist.com/reference/deleteprovideraccess.md
  - https://docs.qwist.com/reference/deleteuser.md
  - https://docs.qwist.com/reference/getaccount.md
  - https://docs.qwist.com/reference/getaccountbalance.md
  - https://docs.qwist.com/reference/getaccountverificationreceipt.md
  - https://docs.qwist.com/reference/getandgenerateincomereport.md
  - https://docs.qwist.com/reference/getartifact.md
  - https://docs.qwist.com/reference/getcategories.md
  - https://docs.qwist.com/reference/getcategoriesforaccess.md
  - https://docs.qwist.com/reference/getcategoriesforaccount.md
  - https://docs.qwist.com/reference/getcategorytree.md
  - https://docs.qwist.com/reference/getcontract.md
  - https://docs.qwist.com/reference/getcredential.md
  - https://docs.qwist.com/reference/getincomereport.md
  - https://docs.qwist.com/reference/getinsurance.md
  - https://docs.qwist.com/reference/getloan.md
  - https://docs.qwist.com/reference/getnotification.md
  - https://docs.qwist.com/reference/getpaymentchallenge.md
  - https://docs.qwist.com/reference/getpaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/getpaymentinitstatus.md
  - https://docs.qwist.com/reference/getpaymentinitstatusofaccount.md
  - https://docs.qwist.com/reference/getpaymentofaccount.md
  - https://docs.qwist.com/reference/getpaymentpartners.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccess.md
  - https://docs.qwist.com/reference/getpaymentpartnersforaccount.md
  - https://docs.qwist.com/reference/getpaymentreceipt.md
  - https://docs.qwist.com/reference/getprovideraccess.md
  - https://docs.qwist.com/reference/getriskreport.md
  - https://docs.qwist.com/reference/getsecurityofaccount.md
  - https://docs.qwist.com/reference/getsyncchallenge.md
  - https://docs.qwist.com/reference/getsyncstatus.md
  - https://docs.qwist.com/reference/gettimeline.md
  - https://docs.qwist.com/reference/gettimelineforaccess.md
  - https://docs.qwist.com/reference/gettimelineforaccount.md
  - https://docs.qwist.com/reference/gettransaction.md
  - https://docs.qwist.com/reference/gettransactionofaccount.md
  - https://docs.qwist.com/reference/getuploadstatus.md
  - https://docs.qwist.com/reference/getuser.md
  - https://docs.qwist.com/reference/getversion.md
  - https://docs.qwist.com/reference/initpayment.md
  - https://docs.qwist.com/reference/initpaymentofaccount.md
  - https://docs.qwist.com/reference/listaccounts.md
  - https://docs.qwist.com/reference/listaccountsofaccess.md
  - https://docs.qwist.com/reference/listbanks.md
  - https://docs.qwist.com/reference/listcatalog.md
  - https://docs.qwist.com/reference/listcatalogclientauth.md
  - https://docs.qwist.com/reference/listclientusers.md
  - https://docs.qwist.com/reference/listcontracts.md
  - https://docs.qwist.com/reference/listcontractsofaccess.md
  - https://docs.qwist.com/reference/listcontractsofaccount.md
  - https://docs.qwist.com/reference/listcredentials.md
  - https://docs.qwist.com/reference/listinsurances.md
  - https://docs.qwist.com/reference/listinsurancesofaccess.md
  - https://docs.qwist.com/reference/listloans.md
  - https://docs.qwist.com/reference/listloansofaccess.md
  - https://docs.qwist.com/reference/listnotifications.md
  - https://docs.qwist.com/reference/listpaymentchallenges.md
  - https://docs.qwist.com/reference/listpaymentchallengesofaccount.md
  - https://docs.qwist.com/reference/listpayments.md
  - https://docs.qwist.com/reference/listpaymentsofaccount.md
  - https://docs.qwist.com/reference/listprovideraccesses.md
  - https://docs.qwist.com/reference/listsecurities.md
  - https://docs.qwist.com/reference/listsecuritiesofaccount.md
  - https://docs.qwist.com/reference/listservices.md
  - https://docs.qwist.com/reference/listsyncchallenges.md
  - https://docs.qwist.com/reference/listtransactions.md
  - https://docs.qwist.com/reference/listtransactionsofaccount.md
  - https://docs.qwist.com/reference/patchcredential.md
  - https://docs.qwist.com/reference/removepinfromprovideraccess.md
  - https://docs.qwist.com/reference/replacenotifications.md
  - https://docs.qwist.com/reference/revokeoauthtoken.md
  - https://docs.qwist.com/reference/solvepaymentchallenge.md
  - https://docs.qwist.com/reference/solvepaymentchallengeofaccount.md
  - https://docs.qwist.com/reference/solvesyncchallenge.md
  - https://docs.qwist.com/reference/updatecontract.md
  - https://docs.qwist.com/reference/updatenotification.md
  - https://docs.qwist.com/reference/updateuser.md
  merge:
    pages: 105
    deduped: 1107
    conflicts_kept_first: 0