Enhanced Reporting Schema
EnhancedReportingSubmissionRequest Complex Type
Enhanced Reporting Schema : EnhancedReportingSubmissionRequest Complex Type
Description
Employer's PAYE Enhanced Reporting Submission Request.
Namespace http://www.ros.ie/schemas/paye-employers/err/v1/enhanced_reporting/
Diagram
LineItemIDToDelete Element Amount Element NumberOfDays Element PaymentDate Element AdvancePaymentReconciliation Element SubCategory Element Category Element DateOfBirth Element CountryCode Element Eircode Element County Element AddressLine Element Sequence Address Element FamilyName Element FirstName Element Sequence Name Element EmployerReference Element EmploymentID Element EmployeePPSN Element Sequence EmployeeID Element PreviousLineItemID Element LineItemID Element Sequence ExpensesBenefits Element Version Element Name Element Sequence SoftwareUsed Element TaxYear Element EnhancedReportingRunReference Element AgentTain Element EmployerRegistrationNumber Element Sequence Header Element SubmissionID Element Sequence EnhancedReportingSubmissionRequest Complex Type
Overview
EnhancedReportingSubmissionRequest
Employer's PAYE Enhanced Reporting Submission Request.
Sequence
SubmissionID submissionID Simple Type
Data Item Ref: 3. Unique submission identifier. Must be unique for submissions under a given employer's PAYE registration number.
Header SubmissionHeader Complex Type
Required header level elements for a submission.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Data Item Ref: 1. Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Data Item Ref: 2. Tax Advisor Identification Number. Required if submission is filed by agent on behalf of employer.
EnhancedReportingRunReference enhancedReportingRunReference Simple Type
Data Item Ref: 4. Enhanced Reporting Run Reference. Used to identify the event to which the submission refers.
TaxYear taxYear Simple Type
Data Item Ref: 6. Tax year to which the submission relates (YYYY).
SoftwareUsed SoftwareUsed Complex Type
Data Item Refs: 7 and 8. Third party software product identifier.
Sequence
Name NonEmptyString Simple Type
Data Item Ref: 7. Name of third party software product.
Version NonEmptyString Simple Type
Data Item Ref: 8. Version of third party software product.
ExpensesBenefits 0..∞ ExpenseBenefit Complex Type
List of Expense Benefits that make up the Employer Enhanced Reporting Submission.
Sequence
LineItemID expenseBenefitLineItemID Simple Type
Data Item Ref: 5. Used to uniquely identify individual line items.
PreviousLineItemID optional expenseBenefitLineItemID Simple Type
Data Item Ref: N/A. Used to identify a previous version of this line item when corrections are made. Can only reference line items within the same Enhanced Reporting Run.
EmployeeID optional EmployeeID Complex Type
Data Item Refs: 9 and 15. Unique references to an employment for an employee. Includes PPSN and Employment ID.
Sequence
EmployeePPSN EmployeePPSN Simple Type
Data Item Ref: 9. Employee's PPS Number.
EmploymentID employmentID Simple Type
Data Item Ref: 15. Employment ID. Unique identifier for each distinct employment for an employee. To be set by the employer.
EmployerReference optional employerReference Simple Type
Data Item Ref: 14. Employee's internal staff identifier/reference. This will be mandatory if the PPSN isn’t available and must remain unchanged in all submissions received until the PPSN is available. Optional if PPSN is available.
Name Name Complex Type
Data Item Ref: 10 and 11. Employee Name. Mandatory.
Sequence
FirstName defaultString Simple Type
Data Item Ref: 10. The first name of the employee.
FamilyName defaultString Simple Type
Data Item Ref: 11. The surname/family name of the employee.
Address optional Address Complex Type
Data Item Ref: 12. Elements required when Employee PPSN is not known.
Sequence
AddressLine 1..3 defaultString Simple Type
Data Item Ref: 12. The address will be mandatory if the PPSN isn’t available. Line 1 of the employee's address is required.
County optional county Simple Type
Data Item Ref: 12. County element of the employee's address.
Eircode optional eircode Simple Type
Data Item Ref: 12. Employee's Eircode (if known). Used for Irish addresses only.
CountryCode optional countryCode Simple Type
Data Item Ref: 12. Country code element. Codes used at the International Standard for country codes ISO 3166 Alpha-3.
DateOfBirth optional xs:date
Data Item Ref: 13. Employee's Date of Birth - format YYYY-MM-DD. This will be mandatory if the PPSN isn’t available.
Category category Simple Type
Data Item Ref: 18. Category of Expense Benefit. Possible values are Travel and Subsistence, Remote Working Daily Allowance, Small Benefits Exemption.
SubCategory optional subcategory Simple Type
Data Item Ref: 19. Subcategory of Expense Benefit. Will be mandatory if relevant category is selected. Possible values for Travel and Subsistence category are Travel Vouched, Travel Unvouched, Subsistence Vouched, Subsistence Unvouched, Site Based Employees, Emergency Travel, Eating on Site, Advance Payment.
AdvancePaymentReconciliation optional xs:boolean
Data Item Ref: 21. Advance Payment Reconciliation. This is to identify if a Travel and Subsistence submission relates to a previously submitted Advance Payment.
PaymentDate xs:date
Data Item Ref: 16. Date employee is paid Expense Benefit (YYYY-MM-DD).
NumberOfDays optional xs:integer
Data Item Ref: 20. Number of Days. The total number of days for the Expense Benefit.
Amount defaultDecimal Simple Type
Data Item Ref: 17. Expense Benefit Amount. The total amount of the Expense Benefit.
LineItemIDToDelete 0..∞ expenseBenefitLineItemID Simple Type
For correction submissions, this should include any line item IDs across the run to be deleted.
Used By
EnhancedReportingSubmissionRequest Element
Source
<xs:complexType name="EnhancedReportingSubmissionRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Employer's PAYE Enhanced Reporting Submission Request.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <!-- Header Elements -->
    <xs:element name="SubmissionID" type="pc:submissionID">
      <xs:annotation>
        <xs:documentation>Data Item Ref: 3. Unique submission identifier. Must be unique for submissions under a given employer's PAYE registration number.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Header" type="pp:SubmissionHeader">
      <xs:annotation>
        <xs:documentation>Required header level elements for a submission.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <!-- Expense Benefit Line Item Elements -->
    <xs:element name="ExpensesBenefits" type="pp:ExpenseBenefit" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>List of Expense Benefits that make up the Employer Enhanced Reporting Submission.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <!-- Expense Benefit Deletion Line Item Elements -->
    <xs:element name="LineItemIDToDelete" type="pc:expenseBenefitLineItemID" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>For correction submissions, this should include any line item IDs across the run to be deleted.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
Enhanced Reporting Schema