LookupRPNRequest Complex Type

Description

Employer's Lookup RPN Request.

Namespace

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

Diagram

Overview

LookupRPNRequest

Employer's Lookup RPN Request.

Sequence

EmployerRegistrationNumber employerReg Simple Type

Employer's PAYE Registration Number.

AgentTain optional agentTAIN Simple Type

Tax Advisor Identification Number. Required if RPN is queried by agent on behalf of employer.

SoftwareUsed SoftwareUsed Complex Type

References to third party software used to lookup RPN.

Sequence

Name NonEmptyString Simple Type

Name of the software used.

Version NonEmptyString Simple Type

Version of the software used.

TaxYear dateYear Simple Type

The tax year to which the RPN lookup relates (YYYY).

DateLastUpdated optional xs:date

Parameter to lookup for RPN updated on or since a given date.

EmployeeID 0..∞ EmployeeID Complex Type

Elements required to lookup RPN for an employee.

Sequence

EmployeePPSN EmployeePPSN Simple Type

Data Item Ref: 108. Employee's PPS Number. Used to identify the employee to which the RPN relates.

EmploymentID optional employmentID Simple Type

Data Item Ref: 110. Employee's Employment ID. Unique identifier for each distinct employment for an employee. If the RPN is being triggered as a result of the employee setting up the employment via Jobs and Pension or contacting Revenue, this field will not be populated.

RangeParameters optional RangeParameters Complex Type

The range of RPN to be retrieved.

Sequence

From xs:unsignedInt

Start index of range lookup.

To xs:unsignedInt

End index of range lookup.

PPSN 0..∞ defaultString Simple Type

List of PPSNs for search

Used By

LookupRPNRequest Element

Source

<xs:complexType name="LookupRPNRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Employer's Lookup RPN Request.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="EmployerRegistrationNumber" type="pc:employerReg">
      <xs:annotation>
        <xs:documentation>Employer's PAYE Registration Number.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AgentTain" type="pc:agentTAIN" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Tax Advisor Identification Number. Required if RPN is queried by agent on behalf of employer.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SoftwareUsed" type="pr:SoftwareUsed">
      <xs:annotation>
        <xs:documentation>References to third party software used to lookup RPN.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TaxYear" type="pc:dateYear">
      <xs:annotation>
        <xs:documentation>The tax year to which the RPN lookup relates (YYYY).</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="DateLastUpdated" type="xs:date" minOccurs="0">
      <xs:annotation>
        <xs:documentation>Parameter to lookup for RPN updated on or since a given date.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="EmployeeID" type="pr:EmployeeID" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>Elements required to lookup RPN for an employee.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RangeParameters" type="pr:RangeParameters" minOccurs="0">
      <xs:annotation>
        <xs:documentation>The range of RPN to be retrieved.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PPSN" type="pc:defaultString" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>List of PPSNs for search </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>