Create new unit transaction
POST {{baseUrl}}/cas/trusts/:trustId/unitTransactions
Create new unit transaction for a trust
Request Body
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| 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'/'Initial' |
| transactionDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Cannot 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 | Mandatory unless certificateType is ‘None’ |
| unitType | 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 | Maximum of 60 characters |
| unitClass | Object | Yes | See table below |
unitClass object
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| descriptions | String | Yes | Maximum of 60 characters |
| cCode | String | Yes | Maximum of 4 characters |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"certificateNumber":"2","certificateType":"Transaction","id":46276,"numberOfUnits":1,"prepareForm":false,"transactionDate":"2020-01-02","type":"Allotment","unitBeneficialOwnerId":null,"unitType":{"currency":"AUD","description":"ORDINARY UNITS","paid":1,"unitClass":{"cCode":"ORD","description":"ORDINARY UNITS"},"unpaid":0},"unitholderId":963075}