Create new share transaction
POST {{baseUrl}}/companies/:companyId/shareTransactions
Create new share transaction for a given company
Request Body
| Key | Datatype | Mandatory | Constraints/Comments |
|---|---|---|---|
| beneficialOwnerId | Number | No | Must be an id of an existing contact |
| certificateType | String | Yes | Must be one of 'Transaction'/'Balance'/'None' |
| certificateNumber | String | Yes | Only mandatory if certificateType is no 'None' |
| numberOfShares | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| prepareForm | Boolean | No | True or False. True will result in change form (484) being prepared for ASIC |
| shareType | Object | Yes | See table below |
| shareholderId | Number | Yes | Must be an id of an existing contact. Contact can only be of type 'People'/'Company'/'Joint Member' |
| transactionDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Can not be before the company's incorporation Datatype |
| type | String | Yes | Must be one of 'Allotment'/'Balance'/'Subscription' |
shareType 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 | |
| shareClass | Object | Yes | See table below |
shareClass 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 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"beneficialOwnerId":null,"certificateNumber":"5","certificateType":"Transaction","id":12713,"numberOfShares":100,"prepareForm":true,"shareType":{"currency":"AUD","description":"ORDINARY SHARES","paid":1,"shareClass":{"cCode":"ORD","description":"ORDINARY SHARES"},"unpaid":0},"shareholderId":11038,"transactionDate":"2021-01-28","type":"Allotment"}