Skip to main content
GET
Get Transactions

Authorizations

Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Query Parameters

page
string

The page number 1 - n

limit
string

The number of items per page. Max is 250. Default is 10.

sortKey
enum<string>

The key to sort the items by. Default is _id.

Available options:
_id,
name,
createdAt,
updatedAt,
transactionDate
sortOrder
enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:
1,
-1
counterparties

Includes counterparties ids. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

accounts

Includes accounts ids. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

categories

Includes categories ids. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

classes

Includes classes ids. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

minAmount

Minimum amount. Expected to be a number string (Int or Float) eg: 1000,1000.5

maxAmount

Maximum amount. Expected to be a number string (Int or Float) eg: 1000,1000.5

startDate
string<date-time>

Start date in ISO format

endDate
string<date-time>

End date in ISO format

mainCategories

The accounts to filter the categories by.. Comma separated list of level two categories eg: INCOME,OTHER_INCOME,SALES,EXPENSE,DEPRECIATION,COST_OF_GOODS_SOLD,OTHER_EXPENSE,OVERHEAD,CURRENT_ASSET,FIXED_ASSET,INVENTORY,NON_CURRENT_ASSET,PREPAYMENT,LIABILITY,CURRENT_LIABILITY,NON_CURRENT_LIABILITY,TAX_PAYABLE,TAX,EQUITY

ne_categories

Excludes categories id, only valid it categories is not present. Comma separated list of object ids eg: 666666666666666666666666,666666666666666666666666

ne_mainCategories

Excludes main categories ids, only valid if main categories is not present. Comma separated list of level two categories eg: INCOME,OTHER_INCOME,SALES,EXPENSE,DEPRECIATION,COST_OF_GOODS_SOLD,OTHER_EXPENSE,OVERHEAD,CURRENT_ASSET,FIXED_ASSET,INVENTORY,NON_CURRENT_ASSET,PREPAYMENT,LIABILITY,CURRENT_LIABILITY,NON_CURRENT_LIABILITY,TAX_PAYABLE,TAX,EQUITY

Response

Get Transactions executed successfully

message
string

Success message

metaData
object
data
object