Create Statutory Paternity Leave Period data

Creates a Statutory Paternity Leave period for an employee

Request

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

Path parameters

Parameter name Value Description Additional
employeeId int32 Required
businessId string Required

Request body

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

{
    "averageWeeklyEarningsOverride": "double",
    "babyDueDate": "date-time",
    "basicPayAdjustmentType": "string",
    "doNotPayReason": "string",
    "employerPensionProtection": "double",
    "id": "int32",
    "isAdoption": "boolean",
    "notes": "string",
    "offsetSpp": "boolean",
    "payLumpSum": "boolean",
    "prevSppEndDate": "date-time",
    "prevSppStartDate": "date-time",
    "spp": [
        {
            "daysPaid": "int32",
            "earnings": "double",
            "payRunId": "int32"
        }
    ],
    "sppAdjust": "double",
    "startDate": "date-time",
    "weeksPaid": "double",
    "weeksToPay": "double"
}

Properties

Name Type Description
averageWeeklyEarningsOverride double Nullable
babyDueDate date-time DateTime
basicPayAdjustmentType string BasicPayAdjustmentTypeEnum

Possible values are:

  • ReduceByStatutoryAmount
  • PayStatutoryAmount
  • PayStatutoryAmountOnTop
doNotPayReason string Nullable

Possible values are:

  • NotEmployedLongEnough
  • LeaveNoticeInvalid
  • EvidenceInvalid
  • EntitledToSsp
  • WorkedDuringPeriod
  • AweNotHighEnough
  • InLegalCustody
  • PayCurtailedShpp
employerPensionProtection double Nullable
id int32 Int32
isAdoption boolean Boolean
notes string String
offsetSpp boolean Boolean
payLumpSum boolean Boolean
prevSppEndDate date-time Nullable
prevSppStartDate date-time Nullable
spp[] array
spp[].daysPaid int32 Int32
spp[].earnings double Nullable
spp[].payRunId int32 Int32
sppAdjust double Nullable
startDate date-time DateTime
weeksPaid double Decimal
weeksToPay double Nullable

Response

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

Status code Description Resource
200 OK

OK

 UkSppDataApiResponseModel