Create New Document Record
POST {{baseUrl}}/companies/:companyId/documents
Create New Document Record for a Company
Request Body
Key | Datatype | Mandatory | Constraints |
---|---|---|---|
name | String | Yes | |
documentDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
asicDocNumber | String | No |
status object
Note: Within Australia, only certain combinations of companyType, companyClass and companySubClass are valid
Key | Datatype | Mandatory | Constraints |
---|---|---|---|
typeId | Long | No | Must be a valid status Id, if not specified will default to 'RECEIVED' |
Request Body
{"asicDocNumber"=>"{{asicDocNumber}}", "documentDate"=>"{{documentDate}}", "name"=>"{{name}}", "status"=>{"typeId"=>3}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"id":"34684684","traceNumber":"84","asicDocNumber":"7e10b1b1","documentDate":"2017-07-01","name":"Annual Reports","status":{"typeId":3}}