Creates a Statutory Shared Parental Leave period for an employee

Request

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

Path parameters

Request body

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

{
    "averageWeeklyEarningsOverride": "double",
    "babyDueDate": "date-time",
    "calculationType": "string",
    "doNotMakeSalarySacrificeDeductions": "boolean",
    "employerPensionProtection": "double",
    "id": "int32",
    "notes": "string",
    "offsetSmp": "boolean",
    "payLumpSum": "boolean",
    "prevSmpEndDate": "date-time",
    "prevSmpStartDate": "date-time",
    "sharedParentalInfo": {
        "partnerFirstName": "string",
        "partnerNino": "string",
        "partnerSurname": "string",
        "paymentOptions": [
            {
                "id": "int32",
                "offset": "boolean",
                "pay": "boolean",
                "weekNumber": "int32"
            }
        ]
    },
    "smp": [
        {
            "daysPaid": "int32",
            "earnings": "double",
            "payRunId": "int32"
        }
    ],
    "smpAdjust": "double",
    "splitDays": "double",
    "startDate": "date-time",
    "weeksPaid": "double",
    "weeksToPay": "double"
}

Properties

Response

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