Save Leave Year Settings

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "leaveAccrualStartDateType": "string",
    "leaveAnniversarySetting": "string",
    "leaveAnniversarySettingDate": "date-time",
    "leaveYearStart": "date-time"
}

Properties

Name Type Description
leaveAccrualStartDateType string LeaveAccrualStartDateType

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
  • CalendarYear
  • CategorySpecificDate
leaveAnniversarySetting string Nullable

Possible values are:

  • EmployeeStartDate
  • CalendarYear
  • SpecifiedDate
leaveAnniversarySettingDate date-time Nullable
leaveYearStart date-time Nullable

Response

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

Status code Description Resource
204 No Content

No Content