Platform OverviewIntegration HubConfiguration and Customisation
API Reference

Get Transactions

get
https://api.sandbox.toq.io/wallet/api/customers//transactions

Returns a paginated list of transactions for the customer, filtered by the provided query parameters (account, company, dates, status, amount range, currency, etc.). Use this endpoint to retrieve the transaction history that powers statements, expense lists and reconciliation views.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

customerId

Query Params
string

Filter by Bank Account ID (source or target account). I.e: 5c3efbeb-b292-42ae-98c2-2a50a7829d05

string

Filter by the base currency (ISO 4217 code) of the bank account. I.e: in:GBP,EUR

boolean

Filter by whether the transaction is billable or not. I.e: true

string

Filter by card ID. I.e: 5c614183-ffdd-4487-ab66-ca20d6806698

string
enum

Filter by category code. I.e: in:meals,internet

string

Filter by a client

string
enum

Filter by the type of client

Allowed:
boolean

Filter by whether the transaction is in a closed period or not. I.e: false

string

Filter by closing date. I.e: btn:2018-06-18,2018-07-18

boolean

Filter: Show team expenses (company=true) if the user has the required permission or only personal expenses (company=false)

string
required

Filter by company ID

string

Filter by the currency (ISO 4217 code) in which the payment was made. It might be same as the currency of the bank account or not. I.e: in:GBP,EUR

string

Filter by a customer

string

Filter by creation date. I.e: btn:2018-06-18,2018-07-18

string

Filter transactions with notes containing the given text. I.e: like:market

string
enum

Filter by INBOUND, OUTBOUND. I.e: OUTBOUND

Allowed:
string

Filter by due date. I.e: btn:2018-06-18,2018-07-18

boolean

Filter by whether the transaction has an attached receipt or not. I.e: false

boolean

If set to true, the transactions without receipt that have been dismissed are filtered out

boolean

Filter by whether the transaction is an invoice or not

string

Filter by invoice date. I.e: btn:2018-06-18,2018-07-18

string
enum

Filter by the expense status. I.e: PAID

Allowed:
int32
enum

Filter by transactions created during the given month. Jan=1, Feb=2, ..., Dec=12. -1 for Year to Date

string
enum

Filter by movement type

Allowed:
int32
int32
string
enum

Filter by payment type. I.e: CARD

Allowed:
boolean

Filter by whether the transaction is recurring or executed only once. I.e: true

string
string
enum

Filter by the transaction status. I.e: neq:FAILED

string
string
enum

Filter by the sync expense with [AccountingProvider]. I.e: SYNCED

Allowed:
string

Filter by tag ID. I.e: in:5c482f7a46e0fb0005d78a2e,5c482f7a46e0fb0005d78a2d

string

Text filter to search in merchant, concept, address and notes, containing any terms from the provided query string. In order to search for exact phrases, wrap them in double-quotes. To exclude a word, you can prepend a "-" character. I.e: Mercado Barcelona

string
string

Filter by transaction amount. lt (<), gt (>), btn (between), etc. I.e: btn:10,45

string
enum

Filter by transfer trigger type. I.e: RECURRING

Allowed:
string
enum

Filter by transaction type. I.e: EXPENSE

Allowed:
string

Filter by user ID

string

Filter by VAT percent value

boolean

This flag determines whether a total of all transactions must be computed or not. For performance reasons, do not activate the flag unless required.

int32

Filter by transactions created during the given year. I.e: 2019

boolean

Filter by billing transaction

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Updated about 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated about 2 months ago

Did this page help you?