Updates the leave category with the specified ID.
PUT https://apisg.yourpayroll.io/api/v2/business/{businessId}/leavecategory/{id}
Parameter name | Value | Description | Additional |
---|---|---|---|
id | int32 | Required | |
businessId | string | Required |
The request body takes a complete SgLeaveCategoryModel 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",
"isNamePrivate": "boolean",
"isPrivate": "boolean",
"leaveAccrualRule": {
"accrualType": "string",
"accrueInAdvance": "boolean",
"capType": "string",
"carryOverAmount": "double",
"carryOverBehaviour": "string",
"id": "int32",
"leaveYearOffsetAmount": "int32",
"unitCap": "double"
},
"leaveCategoryType": "string",
"leaveLoading": "double",
"leaveUnitType": "string",
"name": "string",
"payoutAsETP": "boolean",
"source": "string",
"transferToPayCategoryId": "int32",
"unitType": "string",
"units": "double",
"useDeductFromPayCategoryRate": "boolean"
}
Name | Type | Description |
---|---|---|
automaticallyAccrues | boolean | Boolean |
contingentPeriod | double |
Nullable |
deductFromPayCategoryId | int32 |
Nullable |
deductFromPrimaryPayCategory | boolean | Boolean |
entitlementPeriod | double |
Nullable |
excludeFromTerminationPayout | boolean | Boolean |
externalId | string | String |
hideAccrualsOnPayslip | boolean | Boolean |
id | int32 | Int32 |
isBalanceUntracked | boolean | Boolean |
isNamePrivate | boolean | Boolean |
isPrivate | boolean | Boolean |
leaveAccrualRule | object | SgLeaveAccrualRuleModel |
leaveAccrualRule.accrualType | string |
LeaveAccrualType
Possible values are:
|
leaveAccrualRule.accrueInAdvance | boolean | Boolean |
leaveAccrualRule.capType | string |
LeaveAccrualCapType
Possible values are:
|
leaveAccrualRule.carryOverAmount | double | Decimal |
leaveAccrualRule.carryOverBehaviour | string |
LeaveAccrualCarryOverBehaviour
Possible values are:
|
leaveAccrualRule.id | int32 | Int32 |
leaveAccrualRule.leaveYearOffsetAmount | int32 |
Nullable |
leaveAccrualRule.unitCap | double | Decimal |
leaveCategoryType | string |
LeaveCategoryTypeEnum
Possible values are:
|
leaveLoading | double | Decimal |
leaveUnitType | string |
LeaveUnitTypeEnum
Possible values are:
|
name | string | String |
payoutAsETP | boolean | Boolean |
source | string | String |
transferToPayCategoryId | int32 |
Nullable |
unitType | string |
LeaveAllowanceUnitEnum
Possible values are:
|
units | double | Decimal |
useDeductFromPayCategoryRate | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
SgLeaveCategoryModel |