NiYtdReportReportResponse

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Schema

Name / Description Type / Format Example
basedOnPayrun
If false, then any payrun related information (Tax year, etc) should be ignored.
 boolean true
errorLines NiLetterValidationReportLine[] {NiLetterValidationReportLine}
paymentDate string date "2026-06-04"
employer Item {Item}
payPeriod string "Custom" "Quarterly" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily" "Annual"
ordinal integer int32 0
period integer int32 0
version integer int32 0
periodTo integer int32 0
startPeriodName string "string"
endPeriodName string "string"
startDate string date "2026-06-04"
endDate string date "2026-06-04"
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 string "string"
isDraft boolean true

JSON Example 

{
  "basedOnPayrun": true,
  "errorLines": [
    {
      "employeeId": "string",
      "payrollCode": "string",
      "name": "string",
      "niNumber": "string",
      "gender": "Male",
      "dateOfBirth": "2026-06-04",
      "niLetterError": "XNotUsedForPensionersPayroll",
      "errorDetails": "string",
      "niLetter": "string",
      "suggestedLetter": "string"
    }
  ],
  "paymentDate": "2026-06-04",
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "version": 0,
  "periodTo": 0,
  "startPeriodName": "string",
  "endPeriodName": "string",
  "startDate": "2026-06-04",
  "endDate": "2026-06-04",
  "report": "GrossToNet",
  "taxYear": "Year2017",
  "title": "string",
  "isDraft": true
}

References

Contained in Models
NiLetterValidationReportReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -