Guides

Name / Description	Type / Format	Example
`employeeId` The employee ID	`string` uuid	`"string"`
`employeeUniqueId` The employee uniqueId	`integer` int32	`0`
`payrollCode` The employee payroll code	`string`	`"string"`
`employeeName` The employee name	`string`	`"string"`
`emailAddress` The employee email address	`string`	`"string"`
`roles` The roles associated with the letter	`string`	`"string"`
`assessmentId` The assessment Id the letter is related to	`string` uuid	`"string"`
`isJointAssessment` If the assessment was a joint assessment	`boolean`	`true`
`period` The tax period in which the letter was generated	`integer` int32	`0`
`letterType`	`string`	`"Entitled"` `"NonEligible"` `"Postponed"` `"Enrolled"` `"Reenrolled"`
`sentDate` The roles which generated the letter	`string` date	`"2026-01-17"`
`letterSentType`	`string`	`"Email"` `"Manual"` `"ExternalDataProvider"`
`externalDataProviderId`	`string`	`"SmartPension_Employer"` `"SmartPension_Adviser"` `"PeoplesPension"` `"Xero"` `"Qbo"` `"Sage"` `"Nest"` `"Cashplus"` `"BreatheHr"` `"KashFlow"` `"FreeAgent"` `"FreeAgentPm"` `"Modulr"` `"Square"` `"Cezanne"` `"Ciphr"` `"Telleroo"` `"WeWorked"` `"RotaCloud"` `"Quinyx"` `"Csod"` `"Planday"` `"Starling"` `"Deputy"` `"Bottomline"` `"Twinfield"` `"MyePayWindow"` `"IFinance"` `"AccountsIQ"` `"EPaySlips"` `"NetSuite"` `"StackOne"`

JSON Example

{
  "employeeId": "string",
  "employeeUniqueId": 0,
  "payrollCode": "string",
  "employeeName": "string",
  "emailAddress": "string",
  "roles": "string",
  "assessmentId": "string",
  "isJointAssessment": true,
  "period": 0,
  "letterType": "Entitled",
  "sentDate": "2026-01-17",
  "letterSentType": "Email",
  "externalDataProviderId": "SmartPension_Employer"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations

- none -