QWqwist
Transactions

List transactions

Changed on

Get a list of the transactions of all accounts. You can additionally constrain the amount of transactions being returned by using the query parameters described below as filters.

get/rest/transactions

Request

Query parameters

sort'asc' | 'desc'

Determines whether results will be sorted in ascending or descending order.

since_type'booked' | 'created' | 'modified'

This parameter defines how the parameter since will be interpreted.

untilSchema (unresolved $ref)

Only entities with a corresponding date equal or older to this date will be selected. The type of date that is filtered by is determined by the since_type parameter.

filterstring

Filter transactions by given key:value combination. Possible keys:

  • date (maps to booked_at, please use ISO date here, not datetime)
  • person (maps to payer/payee name)
  • purpose
  • amount

Values are interpreted using wildcards: person:John Doe will match %John Doe%.

sync_idstring UUID

nrich ID of synchronization operation.

Example:a18952ae-a93e-48b5-b863-cf8e47156784

Show only those items that have been created within this synchronization.

contractsstring

Comma-separated list of contract IDs. Only transactions matching these contracts will be selected.

types'Transfer' | 'Standing order' | 'Direct debit' | 'Salary or rent' | 'GeldKarte' | 'Charges or interest' | 'Unknown'

The transaction type.

A comma-separated list of transaction types used for filtering.

include_pendingboolean

This flag indicates whether pending transactions should be included in the response. Pending transactions are always included as a complete set, regardless of the since parameter.

include_statisticsboolean

If true includes statistics on the returned transactions: maximum deposit, total deposits, maximum expense, total expenses.

Parameters

#/paths/~1catalog/get/parameters/0 (unresolved $ref)
#/paths/~1rest~1timeline/get/parameters/5 (unresolved $ref)
#/paths/~1auth~1users/get/parameters/0 (unresolved $ref)
#/paths/~1auth~1users/get/parameters/1 (unresolved $ref)
#/paths/~1rest~1securities/get/parameters/3 (unresolved $ref)
#/paths/~1rest~1categories/get/parameters/8 (unresolved $ref)
#/paths/~1rest~1categories/get/parameters/9 (unresolved $ref)
#/paths/~1rest~1timeline/get/parameters/6 (unresolved $ref)
#/paths/~1rest~1timeline/get/parameters/7 (unresolved $ref)
#/paths/~1rest~1payments/get/parameters/5 (unresolved $ref)

Response

List of transactions.

transactionsSchema[] required(unresolved $ref)

List of transactions.

statusStatus required(unresolved $ref)
deletedstring[] required

List of deleted transaction public ids

Changes

  • 398592d93b1fRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 to the / response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status