Enhanced Reporting Schema
CheckErrRunResponse Complex Type
Enhanced Reporting Schema : CheckErrRunResponse Complex Type
Description
Return the current status of an Employer's PAYE Enhanced Reporting Run. Includes list of submissions that make up the run and includes summary details of processed submissions.
Namespace http://www.ros.ie/schemas/paye-employers/err/v1/enhanced_reporting/
Diagram
Description Element Path Element Code Element Sequence ValidationError Element Amount Element SubCategory Element Category Element EmployerReference Element EmploymentID Element EmployeePPSN Element Sequence EmployeeID Element LineItemID Element Sequence ExpenseBenefitSummary Element ExpensesBenefitsToDeleteCount Element ExpensesBenefitsCount Element Amount Element Sequence ExpenseBenefitSubmissionSummary Element Status Element SubmissionID Element Sequence ExpenseBenefitSubmissions Element Amount Element Status Element Sequence CheckErrRunResponse Complex Type
Overview
CheckErrRunResponse
Return the current status of an Employer's PAYE Enhanced Reporting Run. Includes list of submissions that make up the run and includes summary details of processed submissions.
Sequence
Status runProcessingStatus Simple Type
Data Item Ref: N/A. Current Status of Enhanced Reporting Run. Possible values are Pending or Processed. Will be marked as Pending if any submissions making up the run are at a status of Pending.
Amount optional xs:decimal
Data Item Ref: N/A. Total amount across valid line items for the Enhanced Reporting Run. Included when all submissions received for the run have been processed.
ExpenseBenefitSubmissions 0..∞ ExpenseBenefitSubmissionStatus Complex Type
High Level details of the Expense Benefit Submissions that make up the Expense Benefit Run.
Sequence
SubmissionID submissionID Simple Type
Data Item Ref: 3. Unique ID of the Enhanced Reporting Submission.
Status submissionProcessingStatus Simple Type
Data Item Ref: N/A. Current Status of Enhanced Reporting Submission. Possible values are Pending or Completed.
ExpenseBenefitSubmissionSummary optional ExpenseBenefitSubmissionSummary Complex Type
Summary details of Expense Submission. Included when submission has completed processing.
Sequence
Amount xs:decimal
Data Item Ref: N/A. Total amount across valid line items on submission.
ExpensesBenefitsCount xs:unsignedInt
Data Item Ref: N/A. Total number of line items included on submission.
ExpensesBenefitsToDeleteCount xs:unsignedInt
Total number of Expense Benefit line item IDs for deletion included on submission.
ExpenseBenefitSummary 0..∞ ExpenseBenefitSummary Complex Type
Summary details of individual Expense Benefits that make up the Expense Benefit Run.
Sequence
LineItemID expenseBenefitLineItemID Simple Type
Data Item Ref: 5. Used to uniquely identify individual line items.
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.
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.
Amount xs:decimal
Data Item Ref: 17. Total amount for this Expense Benefit on submission.
ValidationError 0..∞ Error Complex Type
List of Errors (if any) on the CheckErrRunRequest.
Sequence
Code errorCode Simple Type
Technical Error Code - to be used for mapping to error messages.
Path optional errorPath Simple Type
Path to error in schema, if available.
Description errorDescription Simple Type
Technical description of error.
Used By
CheckErrRunResponse Element
Source
<xs:complexType name="CheckErrRunResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Return the current status of an Employer's PAYE Enhanced Reporting Run. Includes list of submissions that make up the run and includes summary details of processed submissions.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="Status" type="pc:runProcessingStatus">
      <xs:annotation>
        <xs:documentation>Data Item Ref: N/A. Current Status of Enhanced Reporting Run. Possible values are Pending or Processed. Will be marked as Pending if any submissions making up the run are at a status of Pending.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Amount" type="xs:decimal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Data Item Ref: N/A. Total amount across valid line items for the Enhanced Reporting Run. Included when all submissions received for the run have been processed.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ExpenseBenefitSubmissions" type="pp:ExpenseBenefitSubmissionStatus" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>High Level details of the Expense Benefit Submissions that make up the Expense Benefit Run.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ExpenseBenefitSummary" type="pp:ExpenseBenefitSummary" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>Summary details of individual Expense Benefits that make up the Expense Benefit Run.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ValidationError" type="pp:Error" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>List of Errors (if any) on the CheckErrRunRequest.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
Enhanced Reporting Schema

Please register for our PIT Support Help Desk for the following: