Updates a Statutory Shared Parental Leave period for an employee
PUT http:///api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{id}
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| employeeId | int32 | Required | |
| id | int32 | Required | |
| businessId | string | Required |
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"
}
| Name | Type | Description |
|---|---|---|
| averageWeeklyEarningsOverride | double |
Nullable |
| babyDueDate | date-time | DateTime |
| calculationType | string |
Nullable Possible values are:
|
| doNotMakeSalarySacrificeDeductions | boolean | Boolean |
| employerPensionProtection | double |
Nullable |
| id | int32 | Int32 |
| notes | string | String |
| offsetSmp | boolean | Boolean |
| payLumpSum | boolean | Boolean |
| prevSmpEndDate | date-time |
Nullable |
| prevSmpStartDate | date-time |
Nullable |
| sharedParentalInfo | object | UkStatutorySharedParentalLeaveInfoModel |
| sharedParentalInfo.partnerFirstName | string | String |
| sharedParentalInfo.partnerNino | string | String |
| sharedParentalInfo.partnerSurname | string | String |
| sharedParentalInfo.paymentOptions[] | array | |
| sharedParentalInfo.paymentOptions[].id | int32 | Int32 |
| sharedParentalInfo.paymentOptions[].offset | boolean | Boolean |
| sharedParentalInfo.paymentOptions[].pay | boolean | Boolean |
| sharedParentalInfo.paymentOptions[].weekNumber | int32 | Int32 |
| smp[] | array | |
| smp[].daysPaid | int32 | Int32 |
| smp[].earnings | double |
Nullable |
| smp[].payRunId | int32 | Int32 |
| smpAdjust | double |
Nullable |
| splitDays | double |
Nullable |
| startDate | date-time | DateTime |
| weeksPaid | double | Decimal |
| weeksToPay | double |
Nullable |
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK OK |
UkSmpDataApiResponseModel |
Powered by DapperDox