Payroll Web Service
MethodCheckPayrollRunOperation
Payroll Web Service > All Operations Resource Group : CheckPayrollRunOperation (Method)
Request (CheckPayrollRunRequest)

The request body is of type CheckPayrollRunRequest.

PayrollRunReference Element Version Element Name Element Sequence SoftwareUsed Element TaxYear Element AgentTain Element EmployerRegistrationNumber Element Sequence CheckPayrollRunRequest Element

Overview

CheckPayrollRunRequest
Request to check the current status of an Employer's PAYE Payroll Run, based on the RunReference.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Tax Advisor Identification Number. Required if payroll submission is filed by an agent on behalf of employer.
TaxYear dateYear Simple Type
Used to identify the tax year to which the submission relates (YYYY).
SoftwareUsed SoftwareUsed Complex Type
Third party software product identifier.
Sequence
Name defaultString Simple Type
Name of third party software product.
Version defaultString Simple Type
Version of third party software product.
PayrollRunReference PayrollRunReference Simple Type
Used to identify the Payroll event that the submission refers to e.g. ‘Site_1_Week_1’.
200 Response (CheckPayrollRunResponse)

The response body is of type CheckPayrollRunResponse.

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 Element

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.
Example
<?xml version="1.0" encoding="UTF-8"?>
<!--Document History:
======== Version 0.9 ====================================
i. Document Created 30/06/2017
======== Version 0.10 ====================================
ii. Document updated on 07/09/2017: 
        The element "TaxYear" was added to the "CheckPayrollRunRequest"
======== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "RunReference" to "PayrollRunReference"
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->

<pay:CheckPayrollRunRequest xmlns:pay="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll/payroll-schema.xsd">
    <pay:EmployerRegistrationNumber>3980609P</pay:EmployerRegistrationNumber>
    <pay:TaxYear>2019</pay:TaxYear>
    <pay:SoftwareUsed>
        <pay:Name>The Software</pay:Name>
        <pay:Version>Version 10.0</pay:Version>
    </pay:SoftwareUsed>
    <pay:PayrollRunReference>00001</pay:PayrollRunReference>
</pay:CheckPayrollRunRequest>

<?xml version="1.0" encoding="UTF-8"?>
<!--Document History:
======== Version 0.9 ====================================
i. Document Created 30/06/2017
======== Version 0.10 ====================================
ii. Document updated on 07/09/2017: 
        The complex type "PayslipSummary" was added to the "CheckPayrollRunResponse" 
====== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "PPSN" to "EmployeePPSN"
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->
<pay:CheckPayrollRunResponse xmlns:pay="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll/payroll-schema.xsd">
    <pay:Status>PROCESSED</pay:Status>
    <pay:TaxOnIncome>1334.48</pay:TaxOnIncome>
    <pay:PRSI>1535.55</pay:PRSI>
    <pay:USC>333.94</pay:USC>
    <pay:LPT>48.75</pay:LPT>
    <pay:Submission>
        <pay:SubmissionID>05</pay:SubmissionID>
        <pay:Status>COMPLETED</pay:Status>
        <pay:SubmissionSummary>
            <pay:TaxOnIncome>1334.48</pay:TaxOnIncome>
            <pay:PRSI>1535.55</pay:PRSI>
            <pay:USC>333.94</pay:USC>
            <pay:LPT>48.75</pay:LPT>
            <pay:PayslipCount>6</pay:PayslipCount>
            <pay:PayslipToDeleteCount>0</pay:PayslipToDeleteCount>
        </pay:SubmissionSummary>
    </pay:Submission>
    <pay:PayslipSummary>
        <pay:LineItemID>E1-v1</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>1175228T</pay:EmployeePPSN>
            <pay:EmploymentID>1</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:TaxOnIncome>226.17</pay:TaxOnIncome>
        <pay:PRSI>381.04</pay:PRSI>
        <pay:USC>70.04</pay:USC>
        <pay:LPT>0</pay:LPT>
    </pay:PayslipSummary>
    <pay:PayslipSummary>
        <pay:LineItemID>E2-v1</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>1175228T</pay:EmployeePPSN>
            <pay:EmploymentID>2</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:TaxOnIncome>417.84</pay:TaxOnIncome>
        <pay:PRSI>177</pay:PRSI>
        <pay:USC>60</pay:USC>
        <pay:LPT>0</pay:LPT>
    </pay:PayslipSummary>
    <pay:PayslipSummary>
        <pay:LineItemID>E3-v2</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>2548936K</pay:EmployeePPSN>
            <pay:EmploymentID>1</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:TaxOnIncome>0</pay:TaxOnIncome>
        <pay:PRSI>19.89</pay:PRSI>
        <pay:USC>.93</pay:USC>
        <pay:LPT>0</pay:LPT>
    </pay:PayslipSummary>
    <pay:PayslipSummary>
        <pay:LineItemID>E4-v3</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>7425001H</pay:EmployeePPSN>
            <pay:EmploymentID>1</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:TaxOnIncome>117.11</pay:TaxOnIncome>
        <pay:PRSI>381.04</pay:PRSI>
        <pay:USC>37.29</pay:USC>
        <pay:LPT>0</pay:LPT>
    </pay:PayslipSummary>
    <pay:PayslipSummary>
        <pay:LineItemID>E5-v1</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>0852473A</pay:EmployeePPSN>
            <pay:EmploymentID>1</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:TaxOnIncome>476.42</pay:TaxOnIncome>
        <pay:PRSI>605.98</pay:PRSI>
        <pay:USC>146.29</pay:USC>
        <pay:LPT>48.75</pay:LPT>
    </pay:PayslipSummary>
    <pay:PayslipSummary>
        <pay:LineItemID>E6-v3</pay:LineItemID>
        <pay:EmployerReference>0001</pay:EmployerReference>
        <pay:TaxOnIncome>96.94</pay:TaxOnIncome>
        <pay:PRSI>20.60</pay:PRSI>
        <pay:USC>19.39</pay:USC>
        <pay:LPT>0</pay:LPT>
    </pay:PayslipSummary>
</pay:CheckPayrollRunResponse>
See Also
All Operations Resource Group | Payroll Web Service

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