List all transaction activity

Returns a list of transactions for a given account. Ordered chronologically by creation date, with the most recent transaction appearing first.

You can use optional parameters to filter the transactions. For example, use budgetId to return only transactions associated with a given budget.

SecurityCommonAuth
Request
path Parameters
accountId
required
string (accountId) <= 36 characters

The ID of the account to work with.

Example: F50072
query Parameters
limit
integer <int32> (limit) [ 1 .. 10000 ]
Default: 100

The maximum number of items to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

Example: offset=200
include
Array of strings

Optional details to include in the response.

Items Enum: "bankFeedDetails" "annotations" "attachments"
Example: include=bankFeedDetails
personId
Array of strings <uuid> (personId)

The ID of the person to work with. Use commas to pass multiple values. Has to be URL encoded.

Example: personId=34edaf73-49be-4669-83ee-1b1f8c680d29%2Ceee079a2-5453-4a69-8d5d-223db353f0f3
type
Array of strings (type)

The type to filter transactions by. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction types.

Items Enum: "exchange" "payment" "deposit" "forwardContract" "drawdown" "card" "cardCheck" "cardRefund" "cashWithdrawal" "atm" "unload" "otherDebit" "load" "cashback" "chargeback" "compensation" "otherCredit" "fee"
Example: type=payment%2Cload
excludeType
Array of strings (type)

The type to exclude in the transactions list. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction types.

Items Enum: "exchange" "payment" "deposit" "forwardContract" "drawdown" "card" "cardCheck" "cardRefund" "cashWithdrawal" "atm" "unload" "otherDebit" "load" "cashback" "chargeback" "compensation" "otherCredit" "fee"
Example: excludeType=payment%2Cload
status
Array of strings (status)

The status to filter transactions by. Use commas to pass multiple values. Has to be URL encoded. Learn more about transaction statuses.

Items Enum: "needsApproval" "fundsRequired" "pending" "complete" "declined" "reverted" "refunded" "cancelled" "open" "cardCheck" "fundsSettled"
Example: status=complete%2Ccancelled
budgetId
Array of strings or null <uuid> (budgetId)

The budgetId to filter transactions by. Use commas to pass multiple values. Has to be URL encoded.

Example: budgetId=34edaf73-49be-4669-83ee-1b1f8c680d16
budgetName
Array of strings or null (budgetName)

The budgetName to filter transactions by. Use commas to pass multiple values. Has to be URL encoded.

Example: budgetName=Account%2Cmarketing
sellCurrency
Array of strings (currencycode)

Filters transactions that include selling these currencies. Use commas to pass multiple values. Has to be URL encoded.

Example: sellCurrency=usd%2Cgbp
buyCurrency
Array of strings (currencycode)

Filters orders that include purchasing these currencies. Use commas to pass multiple values. Has to be URL encoded.

Example: buyCurrency=gbp
startDate
string <date> (startDate)

The earliest date from which to retrieve records (includes records on this date).

Example: startDate=2021-02-15
endDate
string <date> (endDate)

The latest date until which to retrieve records (includes records on this date).

Example: endDate=2021-03-30
search
string (search) <= 100 characters

Term to search the records for.

Example: search=John+Smith
annotationStatus
Array of strings

If annotations is included in the include parameter, this will filter the transactions based on the status of the annotations.

Items Enum: "draft" "submitted" "unannotated"
Example: annotationStatus=draft%2Csubmitted
attachmentStatus
Array of strings

If attachments is included in the include parameter, this will filter the transactions based on whether transactions have attachments or not.

Items Enum: "absent" "present" "lost"
Example: attachmentStatus=absent%2Cpresent
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/activity/{accountId}
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "rows": [
    ]
}