Updates the leave category with the specified ID.

Request

PUT https://api.yourpayroll.com.au/api/v2/business/{businessId}/leavecategory/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

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

{
    "automaticallyAccrues": "boolean",
    "contingentPeriod": "double",
    "deductFromPayCategoryId": "int32",
    "deductFromPrimaryPayCategory": "boolean",
    "entitlementPeriod": "double",
    "excludeFromTerminationPayout": "boolean",
    "externalId": "string",
    "hideAccrualsOnPayslip": "boolean",
    "id": "int32",
    "isBalanceUntracked": "boolean",
    "isPrivate": "boolean",
    "leaveCategoryType": "string",
    "leaveLoading": "double",
    "name": "string",
    "source": "string",
    "transferToPayCategoryId": "int32",
    "unitType": "string",
    "units": "double",
    "useDeductFromPayCategoryRate": "boolean"
}

Properties

Name Type
automaticallyAccrues boolean
contingentPeriod double
deductFromPayCategoryId int32
deductFromPrimaryPayCategory boolean
entitlementPeriod double
excludeFromTerminationPayout boolean
externalId string
hideAccrualsOnPayslip boolean
id int32
isBalanceUntracked boolean
isPrivate boolean
leaveCategoryType string
leaveLoading double
name string
source string
transferToPayCategoryId int32
unitType string
units double
useDeductFromPayCategoryRate boolean

Response

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

Status code Description Resource
200 OK

OK