Updates the leave allowance template with the specified ID.
PUT https://apimy.yourpayroll.io/api/v2/business/{businessId}/leaveallowancetemplate/{id}
Parameter name | Value | Description | Additional |
---|---|---|---|
id | int32 | Required | |
businessId | string | Required |
The request body takes a complete MyLeaveAllowanceTemplateModel resource, containing the following writable properties:
{
"externalId": "string",
"id": "int32",
"leaveAccrualStartDateType": "string",
"leaveCategories": [
{
"accrualRuleLeaveYearOffsetAmount": "int32",
"canApplyForLeave": "boolean",
"leaveAccrualRuleAccrualType": "string",
"leaveAccrualRuleAccrueInAdvance": "boolean",
"leaveAccrualRuleCapType": "string",
"leaveAccrualRuleCarryOverAmount": "double",
"leaveAccrualRuleCarryOverBehaviour": "string",
"leaveAccrualRuleUnitCap": "double",
"leaveCategoryId": "int32",
"leaveCategoryName": "string",
"unitType": "string",
"units": "double"
}
],
"leaveYearStart": "date-time",
"name": "string",
"source": "string"
}
Name | Type | Description |
---|---|---|
externalId | string | String |
id | int32 | Int32 |
leaveAccrualStartDateType | string |
Nullable Possible values are:
|
leaveCategories[] | array | |
leaveCategories[].accrualRuleLeaveYearOffsetAmount | int32 |
Nullable |
leaveCategories[].canApplyForLeave | boolean | Boolean |
leaveCategories[].leaveAccrualRuleAccrualType | string |
LeaveAccrualType
Possible values are:
|
leaveCategories[].leaveAccrualRuleAccrueInAdvance | boolean | Boolean |
leaveCategories[].leaveAccrualRuleCapType | string |
LeaveAccrualCapType
Possible values are:
|
leaveCategories[].leaveAccrualRuleCarryOverAmount | double | Decimal |
leaveCategories[].leaveAccrualRuleCarryOverBehaviour | string |
LeaveAccrualCarryOverBehaviour
Possible values are:
|
leaveCategories[].leaveAccrualRuleUnitCap | double | Decimal |
leaveCategories[].leaveCategoryId | int32 | Int32 |
leaveCategories[].leaveCategoryName | string | String |
leaveCategories[].unitType | string |
Nullable Possible values are:
|
leaveCategories[].units | double |
Nullable |
leaveYearStart | date-time |
Nullable |
name | string | String |
source | string |
ExternalService
Possible values are:
|
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
MyLeaveAllowanceTemplateModel |