Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/smp/employee/{employeeId}

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
employeeId int32 Required
businessId string Required

Request body

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

{
    "doNotPayReason": "string",
    "endDate": "date-time",
    "leaveAccrualId": "int32",
    "leaveDataId": "int32",
    "payType": "string",
    "rate": "double",
    "startDate": "date-time"
}

Properties

Name Type Description
doNotPayReason string Nullable

Possible values are:

  • NotEmployedLongEnough
  • AweNotHighEnough
  • LeaveNoticeInvalid
  • MedicalEvidenceInvalid
  • BabyBornNoticeInvalid
  • InLegalCustody
  • WorkAfterBirth
endDate date-time DateTime
leaveAccrualId int32 Int32
leaveDataId int32 Int32
payType string SmpPayTypeEnum

Possible values are:

  • PayStatutoryAmount
  • ReduceByStatutoryAmount
  • PayStatutoryAmountOnTop
rate double Nullable
startDate date-time DateTime

Response

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

Status code Description Resource
200 OK

OK

UkSmpApiResponseModel