Aggregations

Get categories

Retrieve a list of categories associated to the transactions of this user. Each category entry also includes aggregated statistics of the referenced transactions like total amount, number of transactions, high and low values.

get/rest/categories

Query parameters

periodstring

Only select transactions that were booked in the specified period. 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)
sort'asc' | 'desc'

Determines the sort order of aggregation buckets. Sorting is performed based on the transactions total amount.

amount_gtestring

Only select transactions with an amount equal or greater than this value.

amount_ltstring

Only select transactions with an amount less than this value.

Parameters

#/paths/~1catalog/get/parameters/0 — unresolved $ref
#/paths/~1rest~1timeline/get/parameters/4 — unresolved $ref
#/paths/~1rest~1timeline/get/parameters/5 — unresolved $ref
#/paths/~1rest~1timeline/get/parameters/3 — unresolved $ref
#/paths/~1rest~1timeline/get/parameters/0 — unresolved $ref
#/paths/~1rest~1timeline/get/parameters/1 — unresolved $ref

Response

Transaction aggregation.

idinteger required

ID of the finX standard category.

namestring required

Category name. The language depends on Accept-Language HTTP header provided in the request. Default is German.