Updates the leave category with the specified ID.
PUT https://api.yourpayroll.com.au/api/v2/business/{businessId}/leavecategory/{id}
Parameter name | Value | Description | Additional |
---|---|---|---|
id | int32 | Required | |
businessId | string | Required |
The request body takes a complete AuLeaveCategoryModel resource, containing the following writable properties:
{
"accruesFirstPayRunPerPeriodOnly": "boolean",
"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",
"leaveEntitlement": {
"carryOverAmount": "double",
"carryOverType": "string",
"forfeitureAmount": "double",
"forfeitureMonthsStartAfter": "int32",
"forfeitureType": "string",
"id": "int32",
"isProRata": "boolean",
"leaveBalanceType": "string",
"leaveEntitlementTiers": [
{
"accrualAmount": "double",
"accrualStartAfter": "int32",
"accrualStartAfterUnitType": "string",
"accrualUnitType": "string",
"id": "int32",
"isDeleted": "boolean"
}
],
"standardAllowanceUnitType": "string",
"standardAllowanceUnitTypeAmount": "double"
},
"leaveLoading": "double",
"leaveUnitType": "string",
"name": "string",
"payoutAsETP": "boolean",
"preventNegativeBalanceUnpaidLeaveCategoryId": "int32",
"source": "string",
"transferOnTerminationToPayCategoryId": "int32",
"transferToPayCategoryId": "int32",
"unitType": "string",
"units": "double",
"useDeductFromPayCategoryRate": "boolean"
}
Name | Type | Description |
---|---|---|
accruesFirstPayRunPerPeriodOnly | boolean |
Nullable |
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 | AuLeaveAccrualRuleModel |
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 |
AuLeaveCategoryTypeEnum
Possible values are:
|
leaveEntitlement | object | LeaveEntitlementModel |
leaveEntitlement.carryOverAmount | double | Decimal |
leaveEntitlement.carryOverType | string |
LeaveEntitlementCarryOverType
Possible values are:
|
leaveEntitlement.forfeitureAmount | double | Decimal |
leaveEntitlement.forfeitureMonthsStartAfter | int32 | Int32 |
leaveEntitlement.forfeitureType | string |
LeaveEntitlementForfeitureType
Possible values are:
|
leaveEntitlement.id | int32 | Int32 |
leaveEntitlement.isProRata | boolean | Boolean |
leaveEntitlement.leaveBalanceType | string |
LeaveEntitlementLeaveBalanceType
Possible values are:
|
leaveEntitlement.leaveEntitlementTiers[] | array | |
leaveEntitlement.leaveEntitlementTiers[].accrualAmount | double | Decimal |
leaveEntitlement.leaveEntitlementTiers[].accrualStartAfter | int32 | Int32 |
leaveEntitlement.leaveEntitlementTiers[].accrualStartAfterUnitType | string |
LeaveEntitlementAccrualStartDateUnitType
Possible values are:
|
leaveEntitlement.leaveEntitlementTiers[].accrualUnitType | string |
LeaveEntitlementAccrualUnitType
Possible values are:
|
leaveEntitlement.leaveEntitlementTiers[].id | int32 | Int32 |
leaveEntitlement.leaveEntitlementTiers[].isDeleted | boolean | Boolean |
leaveEntitlement.standardAllowanceUnitType | string |
LeaveEntitlementAccrualUnitType
Possible values are:
|
leaveEntitlement.standardAllowanceUnitTypeAmount | double | Decimal |
leaveLoading | double | Decimal |
leaveUnitType | string |
LeaveUnitTypeEnum
Possible values are:
|
name | string | String |
payoutAsETP | boolean | Boolean |
preventNegativeBalanceUnpaidLeaveCategoryId | int32 |
Nullable |
source | string | String |
transferOnTerminationToPayCategoryId | int32 |
Nullable |
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 |
AuLeaveCategoryModel |