Update Company Details
PATCH {{baseUrl}}/cas/companies/{{companyId}}
Update details for an Individual Company.
Only keys which are being updated need to be supplied.
Request Body
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| name | String | No | |
| number | String | No | Must be a valid ACN if jurisdiction is 'Australia' |
| incorporationDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| annualReviewDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| businessNumber | Number | No | ABN / NZBN |
| registrationState | String | No | Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT' |
| jurisdiction | String | No | |
| type | Object | No | See table below |
| registered | boolean | No | False will be an unregistered company, if not specified will default to true |
type object
Note: Within Australia, only certain combinations of companyType, companyClass and companySubClass are valid
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| companyType | String | No | Must be one of 'Small Proprietary'/'Large Proprietary'/'Public Company' |
| companyClass | String | No | Must be one of 'Limited by Shares'/'Limited by Guarantee'/'Limited by Shares and Guarantee'/'Unlimited'/'No Liability' |
| companySubClass | String | No | Must be one of 'None'/'Superannuation Trustee Company'/'Non Profit Company'/'Home Unit Company'/'Listed'/'Unlisted'/'Section 150 License'/'Unlisted Non Profit |
Request Body
{"name"=>"{{name}}", "number"=>"{{number}}", "incorporationDate"=>"{{incorporationDate}}", "annualReviewDate"=>"{{annualReviewDate}}", "registrationState"=>"{{registrationState}}", "jurisdiction"=>"{{jurisdiction}}", "registered"=>true, "type"=>{"companyClass"=>"{{companyClass}}", "companySubClass"=>"{{companySubClass}}", "companyType"=>"{{companyType}}"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: Created
{"agentId":null,"annualReviewDate":"2017-12-03","businessNumber":"123","id":"ef921aa4-b0f8-4ddd-a5b2-fb97fc9255f8","incorporationDate":"2016-12-18","jurisdiction":"Australia","name":"Test company ABC Pty Ltd","number":"550593336","registrationState":"VIC","registered":true,"type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}}