HomeGuidesAPI Reference
Log In
API Reference

List transactions

get
https://api.finx-s.qwist.cloud/rest/transactions

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.

Query Params
string

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

integer
Defaults to 1000

Limit the number of returned items. In combination with the offset parameter this can be used to paginate the result list.

integer
Defaults to 0

Skip this number of items in the response. In combination with the count parameter this can be used to paginate the result list.

string
enum
Defaults to desc

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

Allowed:
string
enum
Defaults to booked

This parameter defines how the parameter since will be interpreted.

Allowed:

Filter entities based on their finX ID or a date.

string

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.

string

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%.

string

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

string

Only select transactions with an amount less than this value.

string

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

string

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

string

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

string

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

string
enum

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

Allowed:
boolean
Defaults to false

If true amounts will be shown in cents.

boolean
Defaults to false

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.

boolean
Defaults to false

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

Headers
string

Setting the Accept-Language to one of the available languages will return results in this language.

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago