All requests must first be Authorized and must use the HTTP GET method over HTTPS. Results are encoded int UTF-8.
Allows you to get the submission details for a company or specific submission. You should supply either sub_num or both company_num and company_bus_ind.
https://services.vision-net.ie/cws/1.2/submissions?doc_id={doc_id}&sub_num={sub_num}&doc_num={doc_num}&company_num={company_num}&company_bus_ind={company_bus_ind}&sortBy1={sortBy1}&sortDir1={sortDir1}&sortBy2={sortBy2}&sortDir2={sortDir2}&skip={skip}&max={max}&format={format}&htmlEnc={htmlEnc}
| Parameter | Type | Description |
|---|---|---|
| doc_id | Positive Integer | A unique document identifier. |
| sub_num | Positive Integer | A unique number representing a submission of document(s) to the CRO. This may be up to eight digits long. A submission may contain multiple documents, such as an Annual Return and a set of Accounts. |
| doc_num | Positive Integer | If you only want to get one document from a submission, then you can pass the submisison document number. |
| company_num | Positive Integer | The Company Number Or Registered Business Number as defined by the CRO. If the company_num is supplied then you must supply company_bus_ind as B or C |
| company_bus_ind | C or B | C) Company B) Registered Business Name This can be omitted if company_num is not provided |
| sortBy1 | String | The first level of sort for the results. Choose from the following options:
sub_num (default, descending) doc_num sub_type_desc doc_type_desc sub_status_desc sub_received_date sub_effective_date acc_year_to_date |
| sortDir1 | ASC or DESC | Sort ascending or descending (default) |
| sortBy2 | String | The second level of sort for the results. Choose from the following options:
sub_num (default, descending) doc_num sub_type_desc doc_type_desc sub_status_desc sub_received_date sub_effective_date acc_year_to_date |
| sortDir2 | ASC or DESC | Sort ascending (default) or descending |
| skip | Positive Integer | The number of results to skip. Useful if paging through results. |
| max | Positive Integer | The maximum number of results to return. We will only return a maximum of 250 results per search, so it cannot be higher than 250. |
| format | XML or JSON | Return the results in XML (default) or JSON format. |
| htmlEnc | 0 or 1 | If set to one, then String fields will be encoded in HTML format. For XML this parameter is forced to 1. For example, ampersands will be encoded as & |