API ReferenceTransactions

List Transactions

List all transactions

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

formatenumOptionalDefaults to JSON
The format of the response
Allowed values:

Response

A paged array of transactions
amountdouble or null
codestring or null
The code for the transaction
createdAtdatetime or null
customerIdstring or nullformat: "uuid"
The ID of the customer associated with the transaction
datedatetime or null
deletedAtdatetime or null
depositIdstring or nullformat: "uuid"
The ID of the deposit associated with the transaction
fiscalPeriodstring or null
The fiscal period for the transaction
householdobject or null
householdIdstring or nullformat: "uuid"
The ID of the household associated with the transaction
idstring or nullformat: "uuid"
isPaidboolean or null
Whether the transaction is paid
ledgerenum or null
The ledger for the transaction
Allowed values:
notestring or null
Notes about the transaction
organizationIdstring or nullformat: "uuid"
The ID of the organization associated with the transaction
paymentDatedatetime or null
The date the charge was paid
propertyIdstring or nullformat: "uuid"
The ID of the property associated with the transaction
readableIdstring or null
The readable ID for the transaction
reversedTransactionIdstring or nullformat: "uuid"
The ID of the reversed transaction
runningBalanceAmountdouble or null
The running balance amount after the transaction
subjournalenum or null
The subjournal for the transaction
Allowed values:
typeenum or null
The type of the transaction
updatedAtdatetime or null