Returns Reconciliation Web Service
MethodLookupPayrollDetailsByReturnPeriod
Returns Reconciliation Web Service > All Operations Resource Group : LookupPayrollDetailsByReturnPeriod (Method)
Request (LookupPayrollDetailsByReturnPeriodRequest)

The request body is of type LookupPayrollDetailsByReturnPeriodRequest.

PeriodEndDate Element PeriodStartDate Element Sequence ReturnPeriod Element Version Element Name Element Sequence SoftwareUsed Element AgentTain Element EmployerRegistrationNumber Element Sequence LookupPayrollDetailsByReturnPeriodRequest Element

Overview

LookupPayrollDetailsByReturnPeriodRequest
Data Items required for an employer/agent to request to view a Return for a specific period.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Data Item Ref: 201. Employer's PAYE-EMP Registration Number.
AgentTain optional agentTAIN Simple Type
Data Item Ref: 202. Tax Advisor Identification Number. Required if the Payroll Return by Period request is filed by an agent on behalf of an employer.
SoftwareUsed SoftwareUsed Complex Type
Data Item Ref: N/A. Third party software product identifier.
Sequence
Name defaultString Simple Type
Data Item Ref: 205. Name of the third party software used.
Version defaultString Simple Type
Data Item Ref: 206. Version of the third party software used.
ReturnPeriod ReturnPeriod Complex Type
Data Item Ref: N/A. The period the Return relates to.
Sequence
PeriodStartDate xs:date
Data Item Ref: 203. Period start date e.g. 01/01/2019. Used to identify the period the request relates to.
PeriodEndDate xs:date
Data Item Ref: 204. Period end date e.g.31/01/2019. Used to identify the period the request relates to.
200 Response (LookupPayrollDetailsByReturnPeriodResponse)

The response body is of type LookupPayrollDetailsByReturnPeriodResponse.

Description Element Path Element Code Element Sequence ValidationError Element LPT Element USC Element PRSI Element TaxOnIncome Element multiPeriod Element RunDate Element PayrollRunReference Element Sequence PayrollRunDetails Element LPT Element USC Element PRSI Element TaxOnIncome Element Sequence PeriodSummary Element Version Element DateLastUpdated Element PeriodEndDate Element PeriodStartDate Element Sequence ReturnPeriod Element AgentTain Element EmployerRegistrationNumber Element Sequence LookupPayrollDetailsByReturnPeriodResponse Element

Overview

LookupPayrollDetailsByReturnPeriodResponse
Data Items sent to an employer/agent in response to a Payroll Return by Period request to view a Return for a specific period.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Data Item Ref: 201. Employer's PAYE-EMP Registration Number.
AgentTain optional agentTAIN Simple Type
Data Item Ref: 202. Tax Advisor Identification Number. Returned if the Payroll Return by Period request was filed by an agent on behalf of an employer.
ReturnPeriod ReturnPeriod Complex Type
Data Item Ref: N/A. The period the return relates to.
Sequence
PeriodStartDate xs:date
Data Item Ref: 203. Period start date e.g. 01/01/2019. Used to identify the period the request relates to.
PeriodEndDate xs:date
Data Item Ref: 204. Period end date e.g.31/01/2019. Used to identify the period the request relates to.
DateLastUpdated optional xs:date
Data Item Ref: 208. This date indicates when the return was last updated.
Version optional version Simple Type
Data Item Ref: 207. Indicates the version of the return that is being requested.
PeriodSummary optional PeriodSummary Complex Type
Data Item Ref: N/A. The overall totals for PAYE, PRSI (employer and employee), USC and LPT in the selected period.
Sequence
TaxOnIncome xs:decimal
Data Item Ref: 209. The overall total income tax for the period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
PRSI xs:decimal
Data Item Ref: 210. The overall total PRSI (employer and employee) for the period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
USC xs:decimal
Data Item Ref: 211. The overall total USC for the period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
LPT xs:decimal
Data Item Ref: 212. The overall total LPT for the period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
PayrollRunDetails 0..∞ PayrollRunDetails Complex Type
Data Item Ref: N/A. List of individual payroll runs with pay dates in the selected period.
Sequence
PayrollRunReference PayrollRunReference Simple Type
Data Item Ref: 213. The reference number identifies a specific payroll run.
RunDate xs:date
Data Item Ref: 214. The date the payroll run was submitted or last updated.
multiPeriod xs:boolean
Data Item Ref: 215. Indicates if the Payroll Run includes pay dates in other periods. (Only payroll figures with pay dates in the selected period are included in this period's totals).
TaxOnIncome xs:decimal
Data Item Ref: 216. The total amount of Income Tax in the payroll run for this period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
PRSI xs:decimal
Data Item Ref: 217. The total amount of PRSI (employer and employee) in the payroll run for this period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
USC xs:decimal
Data Item Ref: 218. The total amount of USC in the payroll run for this period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
LPT xs:decimal
Data Item Ref: 219. The total amount of LPT in the payroll run for this period. (Only payroll figures with pay dates in the selected period are included in this period's totals).
ValidationError 0..∞ Error Complex Type
List of Submission Validation Errors (if any).
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"?>
<rr:LookupPayrollDetailsByReturnPeriodRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rr="http://www.ros.ie/schemas/paye-employers/v1/returns_reconciliation/" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll_return/returns_reconciliation.xsd">
    <rr:EmployerRegistrationNumber>1234567T</rr:EmployerRegistrationNumber>
    <rr:AgentTain>45879C</rr:AgentTain>
    <rr:SoftwareUsed>
        <rr:Name>The Software</rr:Name>
        <rr:Version>Version 10.0</rr:Version>
    </rr:SoftwareUsed>
    <rr:ReturnPeriod>
        <rr:PeriodStartDate>2019-01-01</rr:PeriodStartDate>
        <rr:PeriodEndDate>2019-01-31</rr:PeriodEndDate>
    </rr:ReturnPeriod>
</rr:LookupPayrollDetailsByReturnPeriodRequest>
<?xml version="1.0" encoding="UTF-8"?>
<rr:LookupPayrollDetailsByReturnPeriodResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rr="http://www.ros.ie/schemas/paye-employers/v1/payroll_return/" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll_return/returns_reconciliation.xsd">
    <rr:EmployerRegistrationNumber>1234567T</rr:EmployerRegistrationNumber>
    <rr:AgentTain>12345A</rr:AgentTain>
    <rr:ReturnPeriod>
        <rr:PeriodStartDate>2019-01-01</rr:PeriodStartDate>
        <rr:PeriodEndDate>2019-01-31</rr:PeriodEndDate>
    </rr:ReturnPeriod>
    <rr:DateLastUpdated>2019-02-06</rr:DateLastUpdated>
    <rr:Version>12456R</rr:Version>
    <rr:PeriodSummary>
        <rr:TaxOnIncome>3000</rr:TaxOnIncome>
        <rr:PRSI>6000</rr:PRSI>
        <rr:USC>4500</rr:USC>
        <rr:LPT>1200</rr:LPT>
    </rr:PeriodSummary>
    <rr:PayrollRunDetails>
        <rr:PayrollRunReference>2019_Jan_WEEK_1</rr:PayrollRunReference>
        <rr:RunDate>2019-01-12</rr:RunDate>
        <rr:multiPeriod>false</rr:multiPeriod>
        <rr:TaxOnIncome>1000</rr:TaxOnIncome>
        <rr:PRSI>2000</rr:PRSI>
        <rr:USC>1500</rr:USC>
        <rr:LPT>400</rr:LPT>
    </rr:PayrollRunDetails>
    <rr:PayrollRunDetails>
        <rr:PayrollRunReference>2019_Jan_Week2</rr:PayrollRunReference>
        <rr:RunDate>2019-01-20</rr:RunDate>
        <rr:multiPeriod>true</rr:multiPeriod>
        <rr:TaxOnIncome>1000</rr:TaxOnIncome>
        <rr:PRSI>2000</rr:PRSI>
        <rr:USC>1500</rr:USC>
        <rr:LPT>400</rr:LPT>
    </rr:PayrollRunDetails>
    <rr:PayrollRunDetails>
        <rr:PayrollRunReference>2019_Jan_Week3</rr:PayrollRunReference>
        <rr:RunDate>2019-01-28</rr:RunDate>
        <rr:multiPeriod>true</rr:multiPeriod>
        <rr:TaxOnIncome>1000</rr:TaxOnIncome>
        <rr:PRSI>2000</rr:PRSI>
        <rr:USC>1500</rr:USC>
        <rr:LPT>400</rr:LPT>
    </rr:PayrollRunDetails>
</rr:LookupPayrollDetailsByReturnPeriodResponse>
See Also
All Operations Resource Group | Returns Reconciliation Web Service

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