Set Leave Allowances

Sets the leave allowances for the specified employee

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/leaveallowances

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

[
    {
        "automaticallyAccrues": "boolean",
        "canApplyForLeave": "boolean",
        "hoursPerYear": "double",
        "leaveAccrualRule": {
            "accrualType": "string",
            "accrueInAdvance": "boolean",
            "capType": "string",
            "carryOverAmount": "double",
            "carryOverBehaviour": "string",
            "id": "int32",
            "unitCap": "double"
        },
        "leaveCategoryId": "string",
        "leaveCategoryName": "string",
        "leaveUnitType": "string",
        "unitType": "string",
        "units": "double"
    }
]

Properties

Name Type Description
automaticallyAccrues boolean Boolean
canApplyForLeave boolean Boolean
hoursPerYear double Decimal
leaveAccrualRule object UkLeaveAccrualRuleModel
leaveAccrualRule.accrualType string LeaveAccrualType

Possible values are:

  • Ongoing
  • Yearly
  • BasedOnLengthOfService
leaveAccrualRule.accrueInAdvance boolean Boolean
leaveAccrualRule.capType string LeaveAccrualCapType

Possible values are:

  • NotLimited
  • Limited
leaveAccrualRule.carryOverAmount double Decimal
leaveAccrualRule.carryOverBehaviour string LeaveAccrualCarryOverBehaviour

Possible values are:

  • CarryEntireAmount
  • CarryHours
leaveAccrualRule.id int32 Int32
leaveAccrualRule.unitCap double Decimal
leaveCategoryId string String
leaveCategoryName string String
leaveUnitType string String
unitType string String
units double Nullable

Response

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

Status code Description Resource
200 OK

OK