Add Statutory Sick Pay

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/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 UkSspApiModel resource, containing the following writable properties:

{
    "averageWeeklyEarningsOverride": "double",
    "basicPayAdjustmentType": "string",
    "doNotPayReason": "string",
    "endDate": "date-time",
    "id": "int32",
    "isLinkedToOccupationalAbsence": "boolean",
    "maximumOffsetDays": "int32",
    "notes": "string",
    "qualifiesForSsp": "boolean",
    "qualifyingDays": "int32",
    "startDate": "date-time",
    "status": "string",
    "waitingDays": "int32",
    "week1QualifyingDays": [
        "string"
    ],
    "week2QualifyingDays": [
        "string"
    ]
}

Properties

Name Type Description
averageWeeklyEarningsOverride double Nullable
basicPayAdjustmentType string Nullable

Possible values are:

  • ReduceByStatutoryAmount
  • PayStatutoryAmount
  • PayStatutoryAmountOnTop
doNotPayReason string Nullable

Possible values are:

  • CanClaimSocialSecurityBenefitAgain
  • FixedContractEnded
  • EmploymentEnded
  • SspCap
  • AverageEarningsNotHighEnough
  • Pregnancy
  • ConstantlySick
  • TradeDispute
  • InLegalCustody
  • WorkingOutsideUk
  • NotStarted
endDate date-time DateTime
id int32 Int32
isLinkedToOccupationalAbsence boolean Boolean
maximumOffsetDays int32 Nullable
notes string String
qualifiesForSsp boolean Boolean
qualifyingDays int32 Int32
startDate date-time DateTime
status string String
waitingDays int32 Nullable
week1QualifyingDays[] array of string

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
week2QualifyingDays[] array of string

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

Response

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

Status code Description Resource
200 OK

OK

 UkSspApiResponseModel