Create auto enrolment notice

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/autoenrolmentnotice

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete AutoEnrolmentNoticeModel resource, containing the following writable properties:

{
    "assessmentStatus": "string",
    "downloadUrl": "string",
    "emailUrl": "string",
    "enrolledDate": "date-time",
    "enrolmentDeferralDate": "date-time",
    "id": "int32",
    "noticeSentDate": "date-time"
}

Properties

Name Type Description
assessmentStatus string PensionAssessmentStatusEnum

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
downloadUrl string String
emailUrl string String
enrolledDate date-time Nullable
enrolmentDeferralDate date-time Nullable
id int32 Nullable
noticeSentDate date-time Nullable

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 AutoEnrolmentNoticeModel