Contract.AeEmployeeLetterResponse

Schema

Name / Description Type / Format Example
period integer int32 0
sentDate string date "2025-10-18"
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"
letterType string "Entitled" "NonEligible" "Postponed" "Enrolled" "Reenrolled"
isJointlyAssessed boolean true
roles string "string"
assessmentId string uuid "string"

JSON Example 

{
  "period": 0,
  "sentDate": "2025-10-18",
  "externalDataProviderId": "SmartPension_Employer",
  "letterType": "Entitled",
  "isJointlyAssessed": true,
  "roles": "string",
  "assessmentId": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations

- none -