ROE Web user requirements – Appendix C
- 1. Overview
- 2. General requirements
- 3. Functional requirements
- 4. System requirements
- 5. Appendix A - ROE Online Data Entry
- 6. Appendix B - Technical Specifications
- 7. Appendix C - Import XML file format
- 8. Appendix D - ROE payroll extract file transfer – XML Ver. 2.0
- 9. Appendix E - ROE payroll extract file transfer - XML file layout and edit – Fishing ROE Version 1.0
7. Appendix C - Import XML file format specification
- File Format: Text File
- File Size: 1,048,576 bytes/characters - maximum
- Naming convention: Suggested file name is a maximum of 256 alphanumeric, file extension must be "XML". Example: IMPORT-00000021-20050722.XML
Note
- File should be opened using a valid XML parser.
- The tag level represents if the tag is contained within another tag or not. The parent tag would be the first previous tag with a lower tag level number.
| Tag Name | Tag Level | Required Tag (Y/N) |
Data Size (Min/Max) |
Description |
|---|---|---|---|---|
| <?xml version="1.0" encoding="ISO-8859-1" ?> | 0 | Y | N/A | This is the first line (pre-processing directive) of the Import XML file. It is included to overwrite the default parsing behavior of Internet Explorer when viewing the content of the Import file within the browser. |
| ROEHEADER | 0 | Y | N/A | This tag serves as the root tag of the import file. Therefore it must be present even though it contains only other tags within it. The following attributes must be present with a corresponding value —Refer to the List of Attributes used in the XML structure: Application FileVersion |
| Issued | 1 | Y | N/A | This tag indicates the beginning of the ROE records that were issued. The following attribute must be present with a corresponding value — Refer to the List of Attributes used in the XML structure:
Count |
| Roe | 2 | Y | N/A | This tag indicates the beginning of an Issued ROE record. Therefore, it must be present when the Count is greater than zero.The following attribute could be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
BulkFileName |
| Serial Number | 3 | Y | 9/9 |
ROE Serial Number
Must be 9 characters. |
| Amended Serial Number | 3 | N | 0/9 |
S.N. of ROE amended
Must be 9 characters . |
| Date Issued | 3 | Y | 8/8 |
ROE Date Issued
Must be 8 characters in the following format: "DDMMYYYY" |
| Business Unit | 3 | Y | N/A | This is the parent tag for the Business Unit information. Must be present. It only contains other tags. |
| Payroll ref number | 4 | N | 0/15 | Employer's payroll reference number May be blank Must be 15 characters or less. |
| Business Number | 4 | Y | 15/15 | Canada Revenue Agency Business Number |
| Employee | 3 | Y | N/A | This is the parent tag for the employee information |
| SIN | 4 | Y | 9/9 | Social Insurance Number of the employee for whom the ROE will be issued |
| First day worked | 4 | Y | 8/8 | First day worked Must not be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Last day for which paid | 4 | Y | 8/8 | Last day for which paid Must not be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Final pay period ending date | 4 | Y | 8/8 | Final pay period ending date Must not be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Total insurable earnings | 4 | Y | 4/9 |
Total insurable earnings
Must not be blank Maximum is 999999.99 |
| Passed | 1 | Y | N/A | This tag indicates the beginning of the ROE records that were passed and saved as draft. The following attribute must be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
Count |
| Roe | 2 | Y | N/A | This tag indicates the beginning of a Passed ROE record. Therefore it must be present when the Count is greater than zero. The following attribute could be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
BulkFileName |
| Amended Serial Number | 3 | N | 0/9 | S.N. of ROE amended |
| Business Unit | 3 | Y | N/A | This is the parent tag for the Business Unit information. |
| Payroll ref number | 4 | N | 0/15 | Employer's payroll reference number |
| Business Number | 4 | Y | 15/15 | Canada Revenue Agency Business Number |
| Employee | 3 | Y | N/A | This is the parent tag for the employee information. |
| SIN | 4 | Y | 9/9 | Social Insurance Number of the employee for whom the ROE will be issued |
| First dayWorked | 4 | Y | 8/8 | First day worked Must not be blank Must be 8 characters in the following format:"DDMMYYYY" |
| Last day for which paid | 4 | Y | 8/8 | Last day for which paid Must not be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Final pay period ending date | 4 | Y | 8/8 | Final pay period ending date Must not be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Failed | 1 | Y | N/A | This tag indicates the beginning of the ROE records that were failed and saved as draft. The following attribute must be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
Count |
| Roe | 2 | Y | N/A | This tag indicates the beginning of a Failed ROE record. Therefore it must be present when the Count is greater than zero. The following attribute could be present with a correspondingvalue —Refer to the List of Attributes used in the XML structure:
BulkFileName |
| Amended Serial Number | 3 | N | 0/9 | S.N. of ROE amended |
| Business Unit | 3 | Y | N/A | This is the parent tag for the Business Unit information. |
| Payroll ref number | 4 | N | 0/15 | Employer's payroll reference number |
| Business Number | 4 | Y | 15/15 | Canada Revenue Agency Business Number |
| Employee | 3 | N | N/A | This is the parent tag for the employee information. |
| SIN | 4 | N | 9/9 | Social Insurance Number of the employee for whom the ROE will be issued |
| First day worked | 4 | N | 8/8 | First day worked May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Last day for which paid | 4 | N | 8/8 | Last day for which paid May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Final pay period ending date | 4 | N | 8/8 | Final pay period ending date May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Rejected | 1 | Y | N/A | This tag indicates the beginning of the ROE records that were rejected. The following attribute must be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
Count |
| Roe | 2 | Y | N/A | This tag indicates the beginning of a Rejected ROE record. Therefore it must be present when the Count is greater than zero. The following attribute could be present with a corresponding value —Refer to the List of Attributes used in the XML structure:
BulkFileName |
| Amended Serial Number | 3 | N | 0/9 | S.N. of ROE amended |
| Business Unit | 3 | Y | N/A | This is the parent tag for the Business Unit information. |
| Payroll ref number | 4 | N | 0/15 | Employer's payroll reference number |
| Business Number | 4 | Y | 15/15 | Canada Revenue Agency Business Number |
| Employee | 3 | N | N/A | This is the parent tag for the employee information. |
| SIN | 4 | N | 9/9 | Social Insurance Number of the employee for whom the ROE will be issued |
| First day worked | 4 | N | 8/8 | First day worked May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Last day for which paid | 4 | N | 8/8 | Last day for which paid May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Final pay period ending date | 4 | N | 8/8 | Special payment Date May be blank Must be 8 characters in the following format: "DDMMYYYY" |
| Name | Used with Tag(s) | Description | Value |
|---|---|---|---|
| Application | ROEHEADER | Indicates the application used to submit the file. It is a fixed value. | ROEWeb |
| FileVersion | ROEHEADER | Indicates the file format version. It is a fixed value. | 1.00 |
| Count | Issued, Passed, Rejected and Failed | Indicates the number of ROE for each category included in the import file. If no record for a category the value is zero. | Up to 9 characters |
| BulkFileName | Roe | Indicates the file name if the ROE was transferred by bulk. Otherwise, the attribute is blank. | Up to 256 characters. |
Report a problem or mistake on this page
- Date modified: