NiLetterValidationReportLine

Schema

Name / Description Type / Format Example
employeeId string uuid "string"
payrollCode string "string"
name string "string"
niNumber string "string"
gender string "Male" "Female"
dateOfBirth string date "2024-12-22"
niLetterError string "XNotUsedForPensionersPayroll" "BUsedForMale" "CUsedBeforeStatePensionAge" "AUsedForUnder21" "AUsedOverStatePensionAge" "HUsedForOver24" "MUsedForOver20" "ZUsedForOver20" "IUsedForMale" "FUsedForNonFreeportWorker" "IUsedForNonFreeportWorker" "LUsedForNonFreeportWorker" "SUsedForNonFreeportWorker" "VUsedForNonVeteran" "VUsedForVeteransFirstEmploymentDateOverOneYearOld" "FUsedForFreeportWorkerOverThreeYearsOld" "IUsedForFreeportWorkerOverThreeYearsOld" "LUsedForFreeportWorkerOverThreeYearsOld" "SUsedForFreeportWorkerOverThreeYearsOld" "XNotUsedForUnder16" "DUsedForNonInvestmentZoneWorker" "EUsedForNonInvestmentZoneWorker" "KUsedForNonInvestmentZoneWorker" "NUsedForNonInvestmentZoneWorker"
errorDetails string "string"
niLetter string "string"
suggestedLetter string "string"

JSON Example 

{
  "employeeId": "string",
  "payrollCode": "string",
  "name": "string",
  "niNumber": "string",
  "gender": "Male",
  "dateOfBirth": "2024-12-22",
  "niLetterError": "XNotUsedForPensionersPayroll",
  "errorDetails": "string",
  "niLetter": "string",
  "suggestedLetter": "string"
}

References

Contained in Models
NiLetterValidationReport
Consumed by Operations

- none -

Returned by Operations

- none -