Trust Unitholders Current Balances
GET {{baseUrl}}/cas/trusts/:trustId/unitholdings?groupByTypes={{groupByTypes}}&date={{date}}
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|
| trustId | String | Required | |
| groupBytypes | String | Optional | True or False |
Response Body
Returns a list containing object as defined below
| Key | Datatype | Constraints |
|---|
| beneficialOwnerId | String | |
| numberOfUnits | number | |
| percentageOfClass | number | |
| unitType | Object | |
| unitholderId | number | |
unitType object
| Key | Datatype | Constraints |
|---|
| currency | String | |
| description | String | |
| paid | number | |
| unitClass | Object | |
| shareSubClass | String | |
| unpaid | number | |
unitClass object
| Key | Datatype | Constraints |
|---|
| cCode | String | |
| description | String | |
Request Params
| Key | Datatype | Required | Description |
|---|
groupByTypes | string | | Optional - True/False - False by default. If 'true', results will be grouped by unitholder and unit types (currency, paid/unpaid, class). If 'false', will group by unitholder- see sample response as an example. |
date | string | | Optional - yyyy-mm-dd - The response will calculate balances for all transactions on or before the ‘date'. |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |