List Documents
GET {{baseUrl}}/companies/:companyId/documents?offset={{offset}}&limit={{limit}}&updatedAfter={{updatedAfter}}
Return a list of company documents for a company. Document IDs returned can be used for subsequent calls.
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|---|---|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
| updatedAfter | date | Optional | UTC date in ISO format: yyyy-MM-dd’T’HH:mm:ss. Example: 2000-10-31T01:30:00Z or 2000-10-31T01:30:00 |
updatedAfter parameter Using this new parameter, the documents list will return just the documents that were updated after the date and time specified. The date must be a UTC date in ISO format: yyyy-MM-dd’T’HH:mm:ss. Example: 2000-10-31T01:30:00Z or 2000-10-31T01:30:00
Example - ‘/companies/:companyId/documents?offset=0&limit=500&updatedAfter=2019-10-31T01:30:00Z’
Response Body
Returns a list of objects as described below
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | |
| traceNumber | Number | Yes | |
| name | String | Yes | |
| documentDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| asicDocNumber | String | No | |
| lastUpdatedTimestamp | Date | Yes | Date and time document was updated |
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 |
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 | |
updatedAfter | string | date |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"documents":[{"id":1011421,"traceNumber":"1190","asicDocNumber":null,"name":"Form - 484 CHANGE TO COMPANY DETAILS","documentDate":"2019-01-01","status":{"id":926875,"createdBy":"MIGRATION USER","type":"SENT TO CLIENT","typeId":3,"effectiveDate":"2019-01-01"}},{"id":1011452,"traceNumber":"386654","asicDocNumber":null,"name":"Form - 484 CHANGE TO COMPANY DETAILS","documentDate":"2019-09-06","status":{"id":926891,"createdBy":"Bec Smith","type":"DOCUMENT PREPARED","typeId":2,"effectiveDate":"2019-09-06"}}],"offset":0,"limit":2,"total":2}