Data Dictionary
Below is the full list of fields in the Company and Submission class.
Depending on which programming language and development approach you use, you may need to implement a class with these
field names to load data directly into your object. A .Net implementation of this is
ready for use and is available on the downloads page.
Company
A single instance of the Company class is returned when getting the details for one company using the primary key. The primary key for a
Company is a combination of company_num and company_bus_ind.
An Array of Company objects is returned when searching for a company.
|
Field
|
Type |
Max Length
|
Description |
| company_num |
Int |
|
Company or Business number |
| company_bus_ind |
String |
1 |
Company Business Indicator: C indicates a Company; B indicates a Business Name |
| company_name |
String |
200 |
The Name of the Company or Business Name (whichever is applicable) |
| company_addr_1 |
String |
800 |
The first line of the address |
| company_addr_2 |
String |
800 |
The second line of the address |
| company_addr_3 |
String |
800 |
The third line of the address |
| company_addr_4 |
String |
800 |
The fourth line of the address |
| company_reg_date |
String |
20 |
Company Registration Date. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| company_status_desc |
String |
100 |
The status of the company |
| company_status_date |
String |
20 |
The date on which the current status of the company was applied. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| last_ar_date |
String |
20 |
Last Annual Return date. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| next_ar_date |
String |
20 |
Next Annual Return Date. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| last_acc_date |
String |
20 |
Last Accounting Year Date. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| comp_type_desc |
String |
100 |
The type of company |
| company_type_code |
Int |
|
The CRO's primary key value corresponding to the company_type_desc.
A full list of the possible values is available on the company types page.
|
| company_status_code |
Int |
|
The CRO's primary key value corresponding to the company_status_desc.
A full list of the possible values is available on the company statuses page.
|
| place_of_business |
String |
|
Where the company_type_code is 28 (meaning External Company), where possible,
this will be set to the country where the original business is registered. Where the data is not available, it
will be empty.
|
| eircode |
String |
|
Example: D01E6W8
|
Highlighted fields:
The three dates which have been highlighted above are only returned when the
client needs to get the details of one company using the primary key.
They are deliberately ignored when searching for a company using the
company search approach. These dates are calculated using
complex database functions. Therefore, to reduce overhead on standard company searches and to
keep the search functionality as fast as possible, the dates will have the value 0001-01-01T00:00:00Z.
Eircode
A new eircode field will be added to this object. The eircode is the new postcode launched in July 2015 to help identify premises in the Republic of Ireland. The eircode field will come after the place_of_business field
|
Field
|
Type |
Max Length
|
Description |
| eircode |
String |
10 |
To allow users to prepare for this change, a new Company test object is available to download via the test api's https://services.cro.ie/cws/companiestest (multiple company search) and https://services.cro.ie/cws/companytest (single company search).
The company test object is the same as the company object except it includes an eircode field |
SubmissionDoc
A single instance of the SubmissionDoc class is returned when
getting the details for one submission using the primary key. The primary key for a
SubmissionDoc is a combination of sub_num and doc_num.
An Array of SubmissionDoc objects is returned when using the
submission search approach. You would use the submission search when you want to list all submission documents
for a company.
Note that a SubmissionDoc object represents a single document for a submission, as a submission
can be have one or more documents. These would be indicated by the doc_num. More about this
is explained on the submission search help page.
|
Field
|
Type |
Max Length |
Description |
| sub_num |
Int |
|
Submission Number |
| doc_num |
Int |
|
Document Number relating to the Submission |
| company_num |
Int |
|
Company or Business number |
| company_bus_ind |
String |
1 |
Company Business Indicator: C indicates a Company; B indicates a Business Name |
| sub_type_desc |
String |
100 |
The type of submission |
| doc_type_desc |
String |
100 |
Type of document |
| sub_status_desc |
String |
50 |
Current status of the Submission |
| sub_received_date |
String |
20 |
The date on which the Submission was received. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| sub_effective_date |
String |
20 |
The submission effective date. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| acc_year_to_date |
String |
20 |
The “Accounts filed up to” date, applicable to Accounts. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ |
| scan_date |
String |
20 |
The date on which the document was last scanned. Combined date and time in UTC (ISO 8601).
Exact format YYYY-MM-DDThh:mm:ssZ. Value will be 0001-01-01T00:00:00Z if document was not scanned |
| num_pages |
Int |
|
The number of pages in the document. Will be 0 if not yet scanned |
| doc_id |
Long Int |
|
The CRO identifier for the document, assuming it was scanned. Will be 0 if not yet scanned |
| file_size |
Int |
|
The size of the document in bytes that the CRO has scanned. Will be 0 if not yet scanned |