List of Unlodged Documents (Firm)
GET {{baseUrl}}/cas/companies/documents/unlodged?offset={{offset}}&limit={{limit}}
This resource will return all unlodged documents that exist in the firm.
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|---|---|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
| Key | Datatype | Mandatory | Constraints/Comments |
|---|---|---|---|
| id | number | Yes | |
| traceNumber | String | Yes | |
| asicDocNumber | String | Yes | |
| name | String | Yes | Form type (i.e form 484) |
| documentDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
lodgementDetails object
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| lodgementDeadlineDate | String | Yes | Format will be ISO 8601 date. Equal to Late date |
| preparedBy | String | Yes | The name of user who prepared the document |
| changesSummary | String | Yes | Changes summary as it displays on documents screen (currently only avaliable for form 484) |
| lodgementURL | String | Yes | |
| electronic | boolean | Yes | Mandatory if the document is able to be electronically lodged |
status objects
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | |
| createdBy | String | Yes | The name of user who created the document |
| type | String | Yes | Descriptive name of Status |
| typeId | Number | Yes | Status Unique Identifier |
| effectiveDate | String | Yes | Format will be ISO 8601 date. Equal to status change date |
company object
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | |
| name | String | Yes | |
| number | String | No | Must be a valid ACN |
| 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 |
| registrationState | String | No | Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT' |
| jurisdiction | String | Yes | Currently only 'Australia' is allowed |
| type | Object | No | See table below |
| agentId | String | No |
type object
Note: Within Australia, only certain combinations of companyType, companyClass and companySubClass are valid
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| companyType | String | Yes | Must be one of 'Small Proprietary'/'Large Proprietary'/'Public Company' |
| companyClass | String | Yes | Must be one of 'Limited by Shares'/'Limited by Guarantee'/'Limited by Shares and Guarantee'/'Unlimited'/'No Liability' |
| companySubClass | String | Yes | Must be one of 'None'/'Superannuation Trustee Company'/'Non Profit Company'/'Home Unit Company'/'Listed'/'Unlisted'/'Section 150 License'/'Unlisted Non Profit |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | string | number | |
limit | string | number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"documents":[{"asicDocNumber":null,"company":{"agentId":9,"annualReviewDate":"2019-01-01","id":"e280a2f7-c8f0-4c72-a7e3-4f32cd37f074","incorporationDate":"2018-01-01","jurisdiction":"Australia","name":"Warren Xerocon 2018 Pty Ltd","number":"111111114","registrationState":"ACT","type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}},"documentDate":"2018-09-05","id":405,"lodgementDetails":{"changesSummary":"[PABLO ROCAS] has been [allotted 100 $1 ORDINARY SHARES] on [{1533859200000}]","electronic":true,"lodgementDeadlineDate":"2018-09-06","lodgementUrl":"https://staging.cas360.com.au/s/html/main.html#/documents?trace=121","preparedBy":"Frank Flann"},"name":"Form - 484 CHANGE TO COMPANY DETAILS","status":{"id":930814,"createdBy":"Frank Flann","type":"DOCUMENT PREPARED","typeId":2,"effectiveDate":"2018-09-05"},"traceNumber":"121"},{"asicDocNumber":null,"company":{"agentId":8,"annualReviewDate":"2019-01-01","id":"e280a2f7-c8f0-4c72-a7e3-4f32cd37f074","incorporationDate":"2018-01-01","jurisdiction":"Australia","name":"Warren Xerocon 2018 Pty Ltd","number":"111111114","registrationState":"ACT","type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}},"documentDate":"2019-03-13","id":427,"lodgementDetails":{"changesSummary":"[DARREN SMITH] has been [Appointed] as the company's [Director] on [01/01/2018]","electronic":true,"lodgementDeadlineDate":"2018-01-28","lodgementUrl":"https://staging.cas360.com.au/s/html/main.html#/documents?trace=122","preparedBy":"Dave Smtih"},"name":"Form - 484 CHANGE TO COMPANY DETAILS","status":{"id":930815,"createdBy":"Dave Smtih","type":"DOCUMENT PREPARED","typeId":2,"effectiveDate":"2019-03-13"},"traceNumber":"122"}],"limit":500,"offset":0,"total":2}