ERN Web Service
MethodLookUpERNOperation
ERN Web Service > All Operations Resource Group : LookUpERNOperation (Method)
Request (LookUpERNRequest)

The request body is of type LookUpERNRequest.

PPSN Element TaxYear Element Version Element Name Element Sequence SoftwareUsed Element AgentTain Element EmployerRegistrationNumber Element Sequence LookUpERNRequest Element

Overview

LookUpERNRequest
Enhanced Reporting Notification Request.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Tax Advisor Identification Number. Required if ERN is queried by agent on behalf of employer.
SoftwareUsed SoftwareUsed Complex Type
References to third party software used to lookup ERN.
Sequence
Name NonEmptyString Simple Type
Name of third party software product.
Version NonEmptyString Simple Type
Version of third party software product.
TaxYear taxYear Simple Type
The tax year to which the ERN lookup relates (YYYY).
PPSN 1..∞ EmployeePPSN Simple Type
List of PPSNs for search.
200 Response (LookUpERNResponse)

The response body is of type LookUpERNResponse.

Id Element Description Element Path Element Code Element Sequence ValidationError Element NoERN Element EmploymentCeased Element FamilyName Element FirstName Element Sequence Name Element EmploymentID Element EmployeePPSN Element Sequence EmployeeID Element Sequence ERN Element DateTimeEffective Element TotalERNCount Element TaxYear Element AgentTain Element EmployerRegistrationNumber Element EmployerName Element Sequence LookUpERNResponse Element

Overview

LookUpERNResponse
Enhanced Reporting Notification Request Response.
Sequence
EmployerName defaultString Simple Type
Data Item Ref: N/A. The official name of the employer.
EmployerRegistrationNumber employerReg Simple Type
Data Item Ref: N/A. Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Data Item Ref: N/A. Tax Advisor Identification Number. Required if ERN queried by agent on behalf of employer.
TaxYear dateYear Simple Type
Data Item Ref: N/A. The tax year to which the ERN lookup relates (YYYY).
TotalERNCount xs:unsignedInt
Data Item Ref: N/A. The total number of ERNs that are associated with the ERN request submitted.
DateTimeEffective xs:dateTime
Data Item Ref: N/A. The date and time the ERN was requested.
ERN 0..∞ ERN Complex Type
Data Item Ref: N/A. List of valid ERNs.
Sequence
EmployeeID EmployeeID Complex Type
Employee's PPS Number and Employment ID (if available).
Sequence
EmployeePPSN EmployeePPSN Simple Type
Employee's PPS Number.
EmploymentID optional employmentID Simple Type
Employment ID. Unique identifier for each distinct employment for an employee. To be set by the employer.
Name optional Name Complex Type
The employee name.
Sequence
FirstName defaultString Simple Type
The first name of the employee.
FamilyName defaultString Simple Type
The surname/family name of the employee.
EmploymentCeased xs:boolean
Employment ceased marker.
NoERN 0..∞ EmployeePPSN Simple Type
Data Item Ref: N/A. EmployeePPSNs of employees who do not currently have an employment associated with the employer.
ValidationError 0..∞ ErrorWithId Complex Type
Data Item Ref: N/A. List of Validation errors (if any) on the Look Up ERN request. Validations are returned with an id field where a PPSN provided is invalid. The id field will not be present where PPSN processing is not reached e.g. No RPN found for the employer.
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
Description of error - to be used for support.
Id errorId Simple Type
Optional ID for error - to be used when multiple customers are validated.
See Also
All Operations Resource Group | ERN Web Service

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