Loket.nl REST API Data Model
PutLeavePolicyByLeavePolicyId |
Edit the details of a leave policy__Activity name :__ PutLeavePolicyByLeavePolicyIdEdit the details of a leave policy
Catalog: LoketNlRest
Schema: LeavePolicy
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
Select loket.nl (REST) API URL: /providers/employers/leavePolicies/{leavePolicyId}
Insert loket.nl (REST) API URL: /providers/employers/leavePolicies/{leavePolicyId}
Update loket.nl (REST) API URL: /providers/employers/leavePolicies/{leavePolicyId}
Delete loket.nl (REST) API URL: /providers/employers/leavePolicies/{leavePolicyId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: put /providers/employers/leavePolicies/{leavePolicyId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PutLeavePolicyByLeavePolicyId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
body |
string |
☑ |
|
Leave policy to edit. |
If-Match |
string |
☐ |
|
Input the value acquired in the ETag header for concurrency control. Please note this is optional (and not recommended for most types of integrations). |
leavePolicyId |
guid |
☑ |
|
The unique identifier of the leave policy |
Table Function Columns
The columns of the table function PutLeavePolicyByLeavePolicyId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
accrualType_key |
int32 |
|
☐ |
The key for the `accrualType` |
accrualType_value |
string |
|
☐ |
The description for the `accrualType` |
additionalLeave_allocationType_key |
int32 |
|
☐ |
The key for the `additionalLeaveAllocationType` |
additionalLeave_allocationType_value |
string |
|
☐ |
The description for the `additionalLeaveAllocationType` |
additionalLeave_referenceDate1_day |
int32 |
|
☐ |
The day of the first reference date. |
additionalLeave_referenceDate1_month_key |
int32 |
|
☐ |
The key for the `referenceMonth` |
additionalLeave_referenceDate1_month_value |
string |
|
☐ |
The description for the `referenceMonth` |
additionalLeave_referenceDate2_day |
int32 |
|
☐ |
The day of the second reference date. |
additionalLeave_referenceDate2_month_key |
int32 |
|
☐ |
The key for the `referenceMonth` |
additionalLeave_referenceDate2_month_value |
string |
|
☐ |
The description for the `referenceMonth` |
dayOfTheMonthToPerformAutomaticLeaveCalculationOn |
int32 |
|
☐ |
They day of the month on which the automatic accrual of (yearly or monthly) leave is performed. The yearly calculation is repeated every month to encompase any changes made that have affect on the past.If for example 31 is chosen and a specific month does not have that day the logic will pick the first available date of said month. |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
leaveEntitlement_excessLeaveToStatutory |
double |
|
☐ |
The excess leave (bovenwetelijk verlof) linked employments are entitled to for a full time contract. |
leaveEntitlement_statutory |
double |
|
☐ |
The statutory leave (wetelijk verlof) linked employments are entitled to for a full time contract. |
leaveEntitlement_wtr |
double |
|
☐ |
The wrt leave (ADV/ATV verlof) linked employments are entitled to for a full time contract. |
leaveRequest_applyLeaveSchedule |
boolean |
|
☐ |
Indicates whether the leave schedule can be enterd and is so it is used when calculating the sugested leave hours for a leave request |
leaveRequest_leavePattern_evenWeeks_friday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_monday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_saturday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_sunday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_thursday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_tuesday |
double |
|
☐ |
|
leaveRequest_leavePattern_evenWeeks_wednesday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_friday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_monday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_saturday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_sunday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_thursday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_tuesday |
double |
|
☐ |
|
leaveRequest_leavePattern_oddWeeks_wednesday |
double |
|
☐ |
|
leaveRequest_useHolidaysInCalculation |
boolean |
|
☐ |
Indicates whether the calculating for sugested leave hours for a leave request takes into account holidays. Is set to true no leave hours are calculated for "The historical date on which the employee was first employed. This field is used when an employee has multiple employments in time. In most cases this field should be used as the date on which the employee started working for the company."eg. When requesting leave for the 24th and 25th of december (25th being a national holiday) the calculation (8 hours a day) will return 8 when `useHolidaysInCalculation` is true and 16 when `useHolidaysInCalculation` is false |
leaveUnitType_key |
int32 |
|
☐ |
The key for the unit type |
leaveUnitType_value |
string |
|
☐ |
The description for the leave unit type |
name |
string(50) |
|
☐ |
The name of the leave policy |
payoutLeaveImmediately |
boolean |
|
☐ |
If leave `accrualType` is set to based on hours worked (uren) then this field allows for the leave hours to be paid out directly instead of being accrued. |
roundingMethod_key |
int32 |
|
☐ |
The key for the roundingMethod |
roundingMethod_value |
string |
|
☐ |
The description for the roundingMethod |
roundTo_key |
int32 |
|
☐ |
The key for the roundTo |
roundTo_value |
string |
|
☐ |
The description for the roundTo |
25-05-2022 14:15 Version 22.1.46-BETA+3385
