transactions

Query

account

Reference of the account(s) assigned to the main side of the transaction (CREDIT -> recipient, DEBIT -> sender)

limit = 100

The number of results to fetch (default 10, max 1000)

offset

The offset to use to fetch

type

The transaction type (DEBIT or CREDIT)

paymentMethodType

The payment method types. Can include null for transactions without a payment method

paymentMethodService

The payment method services.

excludeAccount

Reference of the account(s) assigned to the main side of the transaction you want to EXCLUDE from the results

fromAccount

Reference of the account assigned to the other side of the transaction (CREDIT -> sender, DEBIT -> recipient). Avoid, favor account instead.

host

Reference of the host accounting the transaction

orderBy = { "field": "CREATED_AT", "direction": "DESC" }

The order of results

dateFrom

Only return transactions that were created after this date

dateTo

Only return transactions that were created before this date

clearedFrom

Only return transactions that were cleared after this date

clearedTo

Only return transactions that were cleared before this date

searchTerm

The term to search

hasDebt

If true, return transactions with debt attached, if false transactions without debt attached.

hasExpense

Only return transactions with an Expense attached

expense

Only return transactions with this Expense attached

expenseType

Only return transactions that have an Expense of one of these expense types attached

hasOrder

Only return transactions with an Order attached

order

Only return transactions for this order.

includeHost = true

Used when filtering with the host argument to determine whether to include transactions on the fiscal host account (and children)

includeRegularTransactions = true

Whether to include regular transactions from the account (turn false if you only want Incognito or Gift Card transactions)

includeIncognitoTransactions

If the account is a user and this field is true, contributions from the incognito profile will be included too (admins only)

includeChildrenTransactions

Whether to include transactions from children (Events and Projects)

includeGiftCardTransactions

Whether to include transactions from Gift Cards issued by the account.

includeDebts

Whether to include debt transactions

kind

To filter by transaction kind

group

The transactions group to filter by

virtualCard

isRefund

Only return transactions that are refunds (or not refunds if false)

merchantId

Only return transactions that are associated with these external merchant IDs

accountingCategory

Only return transactions that are associated with these accounting categories

paymentMethod

Only return transactions that are associated with this payment method

payoutMethod

Only return transactions that are associated with this payout method