NiLetterValidationReport

Name / Description Type / Format Example
basedOnPayrun
If false, then any payrun related information (Tax year, etc) should be ignored.
Boolean true
errorLines Null, Array {Null, Array}
paymentDate Null, String date "2026-11-21"
employer Item {Item}
payPeriod String "Custom" "HalfYearly" "Quarterly" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily" "Annual"
ordinal Integer int32 0
period Integer int32 0
version Null, Integer int32 0
periodTo Integer int32 0
startPeriodName Null, String "string"
endPeriodName Null, String "string"
startDate String date "2026-11-21"
endDate String date "2026-11-21"
report String "GrossToNet" "GrossToNetCis" "PayrunPayments" "Furlough" "PensionContribs" "Journal" "HourlyPay" "UmbrellaReconciliation" "UmbrellaStatement" "StatutoryPay" "CostAnalysis" "CostOfEmployment" "FullSummaryOfPay" "P11" "P11d" "P30" "P32" "P45" "P60" "EmployeeExport" "RightToWork" "AeoStatement" "HolidayAllowances" "HolidayPayAccruals" "AeAssessments" "CisStatement" "SubcontractorSummary" "PayrollAnalysis" "VarianceReport" "P11Detailed" "NiLetterValidation" "Ytd" "TaxCodeChanges" "EmployeeBenefits" "MemberEnrolment" "AttachmentOrders" "NiYtd" "ApprenticeshipLevy" "TeachersPensionEoy" "MaternitySchedule" "PaySpine" "SpinePoint" "PayGrades" "PaySpineAllowances" "AverageHolidayPayRate" "EmployeeRoleExport" "HolidayPayAccrualsHours" "GenderPayGap" "PensionMemberships" "PayElement" "LoanBalances" "EmployeeLeave" "AdvancedVarianceReport" "EmployeePayments" "EmployeeLoanExport" "CombinedPensionContributions" "CyclicReenrolment"
taxYear String "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024" "Year2025" "Year2026"
title Null, String "string"
isDraft Boolean true
{
  "basedOnPayrun": true,
  "errorLines": {},
  "paymentDate": "2026-11-21",
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": "string",
    "url": "string"
  },
  "payPeriod": {},
  "ordinal": 0,
  "period": 0,
  "version": 0,
  "periodTo": 0,
  "startPeriodName": "string",
  "endPeriodName": "string",
  "startDate": "2026-11-21",
  "endDate": "2026-11-21",
  "report": {},
  "taxYear": {},
  "title": "string",
  "isDraft": true
}
Consumed by Operations

- none -

Returned by Operations

- none -