Payroll Web Service
MethodCheckPayrollSubmissionOperation
Payroll Web Service > All Operations Resource Group : CheckPayrollSubmissionOperation (Method)
Request (CheckPayrollSubmissionRequest)

The request body is of type CheckPayrollSubmissionRequest.

SubmissionID Element PayrollRunReference Element Version Element Name Element Sequence SoftwareUsed Element TaxYear Element AgentTain Element EmployerRegistrationNumber Element Sequence CheckPayrollSubmissionRequest Element

Overview

CheckPayrollSubmissionRequest
Request to check the current status of an Employer's PAYE Payroll Submission, based on the Submission ID.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Tax Advisor Identification Number. Required if payroll submission filed by 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’.
SubmissionID submissionID Simple Type
Unique Submission ID of the Employer Payroll Submission. Used to identify individual submissions.
200 Response (CheckPayrollSubmissionResponse)

The response body is of type CheckPayrollSubmissionResponse.

Description Element Path Element Code Element Sequence ValidationError Element Description Element Path Element Code Element Sequence Warning Element LineItemID Element Sequence PayslipWarning Element Description Element Path Element Code Element Sequence Error Element LineItemID Element Sequence InvalidPayslip Element PayslipToDeleteCount Element PayslipCount Element LPT Element USC Element PRSI Element TaxOnIncome Element Sequence SubmissionSummary Element Version Element Name Element Sequence SoftwareUsed Element TaxYear Element PayrollRunReference Element AgentTain Element EmployerRegistrationNumber Element Sequence SubmissionHeader Element Status Element Index Element Sequence BatchStatus Element BatchCount Element Status Element SubmissionID Element Sequence CheckPayrollSubmissionResponse Element

Overview

CheckPayrollSubmissionResponse
Return the current status of an Employer's PAYE Payroll Submission. If processed, includes summary totals of valid payslips and validation errors for invalid payslips.
Sequence
SubmissionID submissionID Simple Type
Unique submission identifier. Must be unique for submissions under a given employer's PAYE registration number. For batch submissions, all submissions should have the same SubmissionID and should have the BatchID and BatchCount populated.
Status processingStatus Simple Type
Current Status of Payroll Submission. Possible values are Pending or Completed.
BatchCount optional xs:unsignedShort
Total number of batches for a submission recieved in multiple batches.
BatchStatus 0..∞ BatchStatus Complex Type
Status of each batch for a submission recieved in multiple batches.
Sequence
Index xs:unsignedShort
Unique Index of the submission in the batch submission.
Status processingStatus Simple Type
Current Status of the batch in the Payroll Submission. Possible values are Pending, Completed or NotAcknowledged.
SubmissionHeader SubmissionHeader Complex Type
Header elements that were included in payroll submission that is being checked.
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 payroll submission is filed by agent on behalf of employer.
PayrollRunReference PayrollRunReference Simple Type
Data Item Ref: 4. Payroll Run Reference. Used to identify the Payroll event that the submission refers to e.g. ‘Site_1_Week_1’.
TaxYear dateYear Simple Type
Data Item Ref: 5. Used to identify the tax year to which the submission relates (YYYY).
SoftwareUsed SoftwareUsed Complex Type
Data Item Refs: 6 and 7. 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.
SubmissionSummary optional SubmissionSummary Complex Type
Summary totals for 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.
InvalidPayslip 0..∞ InvalidPayslip Complex Type
List of Invalid Payslips (if any). Any payslips in this list will not have been saved so the payslips will not feed into the employer liability for the statuatory return for the period. Included when the submission has completed processing (if required).
Sequence
LineItemID payrollRunLineItemID Simple Type
LineItemID of the payslip containing validation errors.
Error 1..∞ Error Complex Type
List of validation errors related to the payslip.
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.
PayslipWarning 0..∞ PayslipWarning Complex Type
List of Payslip warnings (if any) associated with Valid payslips. Any payslips in this list will have been saved so the payslips will feed into the employer liability for the statuatory return for the period. Included when the submission has completed processing (if required).
Sequence
LineItemID payrollRunLineItemID Simple Type
LineItemID of the payslip containing validation warnings.
Warning 1..∞ Warning Complex Type
List of validation warnings related to the payslip.
Sequence
Code warningCode Simple Type
Technical Code for warning - to be used for mapping to warning messages.
Path optional warningPath Simple Type
Path to warning in schema, if available.
Description warningDescription Simple Type
Technical description of warning.
ValidationError 0..∞ Error Complex Type
List of Errors (if any) on the CheckPayrollSubmissionRequest.
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 "CheckPayrollSubmissionRequest" 
        The element "RunReference was added to the CheckPayrollSubmissionRequest"
======== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "RunReference" to "PayrollRunReference"
======== Version 1.0 Milestone 2 ====================================
iv. Document updated on 09/02/2018:
        Date re-formatted
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->

<pay:CheckPayrollSubmissionRequest 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>4587256A</pay:EmployerRegistrationNumber>
    <pay:AgentTain>45879C</pay:AgentTain>
    <pay:TaxYear>2019</pay:TaxYear>
    <pay:SoftwareUsed>
        <pay:Name>The Software</pay:Name>
        <pay:Version>Version 10.0</pay:Version>
    </pay:SoftwareUsed>
    <pay:PayrollRunReference>0000001</pay:PayrollRunReference>
    <pay:SubmissionID>05</pay:SubmissionID>
</pay:CheckPayrollSubmissionRequest>
<?xml version="1.0" encoding="UTF-8"?>
<!--Document History:
======== Version 0.9 ====================================
i. Document Created 30/06/2017
======== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "RunReference" to "PayrollRunReference"
        Removed the element: "SubmissionType"
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->
<pay:CheckPayrollSubmissionResponse 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:SubmissionID>05</pay:SubmissionID>
    <pay:Status>COMPLETED</pay:Status>
    <pay:BatchCount>6</pay:BatchCount>
    <pay:BatchStatus>
        <pay:Index>1</pay:Index>
        <pay:Status>COMPLETED</pay:Status>
    </pay:BatchStatus>
    <pay:SubmissionHeader>
        <pay:EmployerRegistrationNumber>4587256A</pay:EmployerRegistrationNumber>
        <pay:PayrollRunReference>0000001</pay:PayrollRunReference>
        <pay:TaxYear>2019</pay:TaxYear>
        <pay:SoftwareUsed>
            <pay:Name>The Software</pay:Name>
            <pay:Version>Version10.0</pay:Version>
        </pay:SoftwareUsed>
    </pay:SubmissionHeader>
    <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:CheckPayrollSubmissionResponse>
See Also
All Operations Resource Group | Payroll Web Service

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