v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Performance

Retrieve Account Performance

Retrieves end of day account performance including balances, cash flows, rate of return and a variety of attributes by accountNo.

get/accounts/{accountID}/performance-returns

Path parameters

accountIDstring required

The user's unique account identifier.

Example:cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759

Query parameters

frequency'D' | 'W' | 'M' | 'Y' required

Used for frequency of response. D = Daily, W = Weekly, M = Monthly, Y = Yearly.

fromstring date required

A filter, the start date.

Example:2022-12-25
tostring date required

A filter, the end date.

Example:2022-12-26

Response

Retrieving Account Performance details by accountID was Successful.

accountIDstring

The user's unique account identifier.

accountNostring

The user's unique account number, that is human readable.

startDatestring date

Requested start date of the accounts performance period.

endDatestring date

Requested end date of the accounts performance period.

lastUpdatedstring date

The date and time the this request.