Create Statutory Maternity Leave Period data

Creates a Statutory Maternity Leave period for an employee

Request

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

Path parameters

Parameter name Value Description Additional
employeeId int32 Required
businessId string Required

Request body

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

{
    "averageWeeklyEarningsOverride": "double",
    "babyDueDate": "date-time",
    "calculationType": "string",
    "doNotMakeSalarySacrificeDeductions": "boolean",
    "doNotPayReason": "string",
    "employerPensionProtection": "double",
    "id": "int32",
    "notes": "string",
    "occupationalMaternity": {
        "leaveCategoryId": "int32",
        "ompAdjust": "double",
        "overriddenSalary": "double",
        "overriddenServiceBandId": "int32",
        "overrideServiceBand": "boolean",
        "salaryIsOverridden": "boolean",
        "serviceBandId": "int32"
    },
    "offsetSmp": "boolean",
    "payLumpSum": "boolean",
    "prevSmpEndDate": "date-time",
    "prevSmpStartDate": "date-time",
    "smp": [
        {
            "daysPaid": "int32",
            "earnings": "double",
            "payRunId": "int32"
        }
    ],
    "smpAdjust": "double",
    "startDate": "date-time",
    "weeksPaid": "double",
    "weeksToPay": "double"
}

Properties

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

Possible values are:

  • AlignWithPayPeriod
  • WeeklyPayments
doNotMakeSalarySacrificeDeductions boolean Boolean
doNotPayReason string Nullable

Possible values are:

  • NotEmployedLongEnough
  • AweNotHighEnough
  • LeaveNoticeInvalid
  • MedicalEvidenceInvalid
  • BabyBornNoticeInvalid
  • InLegalCustody
  • WorkAfterBirth
  • PayCurtailedShpp
employerPensionProtection double Nullable
id int32 Int32
notes string String
occupationalMaternity object UkOccupationalMaternityLeaveDataApiModel
occupationalMaternity.leaveCategoryId int32 Nullable
occupationalMaternity.ompAdjust double Nullable
occupationalMaternity.overriddenSalary double Nullable
occupationalMaternity.overriddenServiceBandId int32 Nullable
occupationalMaternity.overrideServiceBand boolean Boolean
occupationalMaternity.salaryIsOverridden boolean Boolean
occupationalMaternity.serviceBandId int32 Nullable
offsetSmp boolean Boolean
payLumpSum boolean Boolean
prevSmpEndDate date-time Nullable
prevSmpStartDate date-time Nullable
smp[] array
smp[].daysPaid int32 Int32
smp[].earnings double Nullable
smp[].payRunId int32 Int32
smpAdjust 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

 UkSmpDataApiResponseModel