LookupPayrollDetailsByReturnPeriodRequest Complex Type

Description

Data Items required for an employer/agent to request to view a Return for a specific period.

Namespace

http://www.ros.ie/schemas/paye-employers/v1/returns_reconciliation/

Diagram

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.

Used By

LookupPayrollDetailsByReturnPeriodRequest Element

Source

<xs:complexType name="LookupPayrollDetailsByReturnPeriodRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Data Items required for an employer/agent to request to view a Return for a specific period.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="EmployerRegistrationNumber" type="pc:employerReg">
      <xs:annotation>
        <xs:documentation>Data Item Ref: 201. Employer's PAYE-EMP Registration Number.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AgentTain" type="pc:agentTAIN" minOccurs="0">
      <xs:annotation>
        <xs:documentation>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.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SoftwareUsed" type="rr:SoftwareUsed">
      <xs:annotation>
        <xs:documentation>Data Item Ref: N/A. Third party software product identifier.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ReturnPeriod" type="rr:ReturnPeriod">
      <xs:annotation>
        <xs:documentation>Data Item Ref: N/A. The period the Return relates to.</xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>