List of Unit Transactions
GET {{baseUrl}}/cas/trusts/:trustId/unitTransactions?offset={{offset}}&limit={{limit}}
Returns a list of unit transactions for a trust
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
| Key | Datatype | Mandatory | Constraints |
|---|
| id | Number | Yes | |
| unitholderId | Number | Yes | Must be an id of an existing contact. Contact can only be of type 'People'/'Company'/'Joint Member' |
| beneficialOwnerId | Number | No | Must be an id of an existing contact |
| type | String | Yes | Must be one of 'Allotment'/'Balance' |
| transactionDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Can not be before the company's incorporation Datatype |
| numberOfUnits | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| certificateType | String | Yes | Must be one of 'Transaction'/'Balance'/'None' |
| certificateNumber | String | Yes | Only mandatory if certificateType is no 'None' |
| unitClass | Object | Yes | See table below |
unitType object
| Key | Datatype | Mandatory | Constraints |
|---|
| paid | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| unpaid | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| currency | String | Yes | an ISO currency code https://en.wikipedia.org/wiki/ISO_4217 |
| description | String | No | Description of Units |
| unitClass | Object | Yes | See table below |
unitClass object
| Key | Datatype | Mandatory | Constraints |
|---|
| descriptions | String | Yes | |
| cCode | String | Yes | |
Additional keys
| Key | Datatype | Mandatory | Constraints |
|---|
| offset | Number | Yes | |
| limit | Number | Yes | |
| total | Number | Yes | |
Request Params
| Key | Datatype | Required | Description |
|---|
offset | string | | number |
limit | string | | number |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |
RESPONSES
status: OK
{"limit":500,"offset":0,"total":1,"unitTransactions":[{"certificateNumber":"1","certificateType":"Transaction","id":46275,"numberOfUnits":1,"prepareForm":true,"transactionDate":"2013-07-02","type":"Allotment","unitBeneficialOwnerId":null,"unitType":{"currency":"AUD","description":"ORDINARY UNITS","paid":1,"unitClass":{"cCode":"ORD","description":"ORDINARY UNITS"},"unpaid":0},"unitholderId":963075}]}