Update the leave settings for the business

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/leavesettings

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "leaveAccrualStartDateType": "string",
    "leaveCalculationMethod": "string",
    "leaveYearShouldStartOn": "date-time",
    "requireNotesForLeaveRequests": "boolean"
}

Properties

Name Type Description
leaveAccrualStartDateType string LeaveAccrualStartDateType

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
  • CalendarYear
  • CategorySpecificDate
leaveCalculationMethod string LeaveEntitlementCalculationMethodEnum

Possible values are:

  • FullYear365
  • Workdays261
leaveYearShouldStartOn date-time Nullable
requireNotesForLeaveRequests boolean Boolean

Response

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

Status code Description Resource
200 OK

OK