List of Share Transactions
GET {{baseUrl}}/companies/:companyId/shareTransactions?offset={{offset}}&limit={{limit}}
Returns a list of company share transactions for a given company
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 | |
| shareholderId | 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 |
| numberOfShares | 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' |
| prepareForm | Boolean | No | True or False. True will result in change form (484) being prepared for ASIC |
| shareType | Object | Yes | See table below |
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 | |
Request Params
| Key | Datatype | Required | Description |
|---|
offset | string | | number |
limit | string | | number |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |
RESPONSES
status: OK
{"companyId":"7d9f84cc-4801-40ce-aeb5-42e29e91b807","limit":500,"offset":0,"shareTransactions":[{"beneficialOwnerId":null,"certificateNumber":"1","certificateType":"Transaction","id":12710,"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-29","type":"Allotment"},{"beneficialOwnerId":null,"certificateNumber":"2","certificateType":"Balance","id":12711,"numberOfShares":1,"prepareForm":true,"shareType":{"currency":"AUD","description":"ORDINARY SHARES","paid":1,"shareClass":{"cCode":"ORD","description":"ORDINARY SHARES"},"unpaid":0},"shareholderId":11038,"transactionDate":"2021-03-29","type":"Return of capital Transfer out"},{"beneficialOwnerId":null,"certificateNumber":"3","certificateType":"Transaction","id":12712,"numberOfShares":1,"prepareForm":true,"shareType":{"currency":"AUD","description":"ORDINARY SHARES","paid":0.99,"shareClass":{"cCode":"ORD","description":"ORDINARY SHARES"},"unpaid":0},"shareholderId":11038,"transactionDate":"2021-03-29","type":"Return of capital Transfer in"}],"total":3}