Payroll Schema
CheckPayrollRunResponse Complex Type
Payroll Schema : CheckPayrollRunResponse Complex Type
Description
Return the current status of an Employer's PAYE Payroll Run. Includes list of submissions that make up the payroll run and includes summary details of processed submissions.
Namespace http://www.ros.ie/schemas/paye-employers/v1/payroll/
Diagram
Description Element Path Element Code Element Sequence ValidationError Element LPT Element USC Element PRSI Element TaxOnIncome Element EmployerReference Element EmploymentID Element EmployeePPSN Element Sequence EmployeeID Element LineItemID Element Sequence PayslipSummary Element PayslipToDeleteCount Element PayslipCount Element LPT Element USC Element PRSI Element TaxOnIncome Element Sequence SubmissionSummary Element Status Element SubmissionID Element Sequence Submission Element LPT Element USC Element PRSI Element TaxOnIncome Element Status Element Sequence CheckPayrollRunResponse Complex Type
Overview
CheckPayrollRunResponse
Return the current status of an Employer's PAYE Payroll Run. Includes list of submissions that make up the payroll run and includes summary details of processed submissions.
Sequence
Status processingStatus Simple Type
Current Status of Payroll Run. Possible values are Pending or Processed. Will be marked as Pending if any submissions making up the Payroll Run are at a status of Pending.
TaxOnIncome optional xs:decimal
Total Tax on Income amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.
PRSI optional xs:decimal
Total PRSI amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.
USC optional xs:decimal
Total USC amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.
LPT optional xs:decimal
Total LPT amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.
Submission 0..∞ SubmissionStatus Complex Type
High Level details of the Payroll Submissions that make up the Payroll Run.
Sequence
SubmissionID submissionID Simple Type
Unique ID of the Payroll Submission.
Status processingStatus Simple Type
Current Status of Payroll Submission. Possible values are Pending or Completed.
SubmissionSummary optional SubmissionSummary Complex Type
Summary details of submission. Included when submission has completed processing.
Sequence
TaxOnIncome xs:decimal
Total Tax on Income amount across valid line items on submission.
PRSI xs:decimal
Total PRSI amount across valid line items on submission.
USC xs:decimal
Total USC amount across valid line items on submission.
LPT xs:decimal
Total LPT amount across valid line items on submission.
PayslipCount xs:unsignedInt
Total number of payslip line items included on submission.
PayslipToDeleteCount xs:unsignedInt
Total number of payslip line item IDs for deletion included on submission.
PayslipSummary 0..∞ PayslipSummary Complex Type
Summary details of individual payslips that make up the Payroll Run.
Sequence
LineItemID payrollRunLineItemID Simple Type
Data Item Ref: N/A. Used to uniquely identify individual line items.
EmployeeID optional EmployeeID Complex Type
Unique references to an employment for an employee. Includes PPSN and Employment ID.
Sequence
EmployeePPSN EmployeePPSN Simple Type
Data Item Ref: 8. Employee's PPS Number.
EmploymentID employmentID Simple Type
Data Item Ref: 14. 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: 13. 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.
TaxOnIncome xs:decimal
Total Tax on Income for this payslip on submission.
PRSI xs:decimal
Total PRSI amount for this payslip on submission.
USC xs:decimal
Total USC amount for this payslip on submission.
LPT xs:decimal
Total LPT amount for this payslip on submission.
ValidationError 0..∞ Error Complex Type
List of Errors (if any) on the CheckPayrollRunRequest.
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
CheckPayrollRunResponse Element
Source
<xs:complexType name="CheckPayrollRunResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Return the current status of an Employer's PAYE Payroll Run. Includes list of submissions that make up the payroll run and includes summary details of processed submissions.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="Status" type="pc:processingStatus">
      <xs:annotation>
        <xs:documentation>Current Status of Payroll Run. Possible values are Pending or Processed. Will be marked as Pending if any submissions making up the Payroll Run are at a status of Pending.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TaxOnIncome" type="xs:decimal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Total Tax on Income amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PRSI" type="xs:decimal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Total PRSI amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="USC" type="xs:decimal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Total USC amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="LPT" type="xs:decimal" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Total LPT amount across valid line items for the payroll run. Included when all submissions received for the payroll run have been processed.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="Submission" type="pp:SubmissionStatus" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>High Level details of the Payroll Submissions that make up the Payroll Run.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PayslipSummary" type="pp:PayslipSummary" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>Summary details of individual payslips that make up the Payroll 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 CheckPayrollRunRequest.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
Payroll Schema

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