Create Company Address
POST {{baseUrl}}/companies/:companyId/addresses
Creates a company address.
Constraint: If an address already exists for this company with the same type & effective date, the request will be rejected
Request Body
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| addressId | Number | Yes | |
| effectiveDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. |
| officeOccupier | String | No | Only valid for Registered Office Address |
| prepareForm | Boolean | No | true = Change to be notified to ASIC within 28 days on a Form 484 Change to Company Details |
| type | String | Yes | Must be one of 'Registered Office Address'/'Business Address'/'Postal Address'’/’Meeting Address’ |
Response Body
Returns a list containing objects as described below
| Key | Datatype | Constraints |
|---|---|---|
| addressId | Number | |
| effectiveDate | String | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. |
| id | Number | Yes |
| officeOccupier | String | Only valid for Registered Office Address |
| type | String | Must be one of 'Registered Office Address'/'Business Address'/'Postal Address'’/’Meeting Address’ |
| prepareForm | Boolean | Change to be notified to ASIC within 28 days on a Form 484 Change to Company Details. |
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
{"addressId":1458,"effectiveDate":"2021-03-28","id":11066,"officeOccupier":"null","prepareForm":true,"type":"Registered Office Address"}