Guides

Name / Description	Type / Format	Example
`type` The content-type, this would usually be the same as the accept header you provided when you requested the report	`string`	`"string"`
`content` This could contain a link to a PDF file, HTML content or other content, depending on the Type value.	`string`	`"string"`
`model`	`NiLetterValidationReport`	`{NiLetterValidationReport}`
`stream` byte array	`string` byte	`"string"`

JSON Example

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

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
NI Letter Validation (Payrun)
NI Letter Validation (Employees)