Loket.nl REST API Data Model
ActualWorkingHoursByEmployerId |
List of actual working hours for an employer__Activity name:__ GetActualWorkingHoursByEmployerIdGet the list of actual working hours for an employer
Catalog: LoketNlRest
Schema: Actuals
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/{employerId}/actualworkinghours
Insert loket.nl (REST) API URL: /providers/employers/{employerId}/actualworkinghours
Update loket.nl (REST) API URL: /providers/employers/{employerId}/actualworkinghours
Delete loket.nl (REST) API URL: /providers/employers/{employerId}/actualworkinghours
Field Selection Method: NotRequired
Base Path: _embedded[*]
Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/actualworkinghours
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ActualWorkingHoursByEmployerId. 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 |
|---|---|---|---|---|
employerId |
guid |
☑ |
|
The unique identifier of the employer |
referenceDate |
datetime |
☐ |
|
Set a reference date for choosing the date dependent data. |
Table Function Columns
The columns of the table function ActualWorkingHoursByEmployerId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
employmentId |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
workingHours_aggregatedHoursPerWeek |
double |
|
☐ |
This read-only field provides the user with a single point of knowledge as to what number of hours per week employment is actually registered in regards to the payrolling process. This number may be respectively based on the workpattern, deviating hours per week or shift hours. If the employment is an 'on call employment' (oproepkracht/invalkracht) the number is either NULL or represents the min-hours if that is applicable.This field is especially useful for third-parties that want to know the number of hours per week (without having to apply specific Loket logic). I.e. this field is not visible in Loket GUI. |
workingHours_averageHoursPerWeek |
double |
|
☐ |
This field can be used to register the average hours per week an employment with varying hours works. For example, 0 hour contracts and min max contracts. The value of this field does NOT directly affect the payrolling proces. |
workingHours_averageParttimeFactor |
double |
|
☐ |
This field is used to register the deviating value of the parttimefactor, purely for administrative purposes. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100. Please note that this field is not used in the actual payroll proces! For the payroll process the number of hours is used. |
workingHours_calculateUsingWorkPattern_daysDailyRate |
boolean |
|
☐ |
Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. |
workingHours_calculateUsingWorkPattern_deviatingDaysAndHours |
boolean |
|
☐ |
Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)! |
workingHours_calculateUsingWorkPattern_hoursBrokenPeriod |
boolean |
|
☐ |
Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service. |
workingHours_calculateUsingWorkPattern_hoursRegularPeriod |
boolean |
|
☐ |
Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. |
workingHours_calculateUsingWorkPattern_leaveHours |
boolean |
|
☐ |
Indicates whether then leave balances (verlof) are to be calculated based on the workpattern. |
workingHours_contractCode_code |
int32 |
|
☐ |
|
workingHours_contractCode_description |
string |
|
☐ |
|
workingHours_contractCode_key |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
workingHours_deviatingHoursPerWeek |
double |
|
☐ |
If this field is empty the fulltime hours are based as defined by the shift, this optional field is used to register an overwriting value. The value can be less or more then the fulltime hours a week. |
workingHours_deviatingSvDaysPerPeriod |
int32 |
|
☐ |
Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. |
workingHours_endDate |
datetime |
|
☐ |
The end date of the entity. The date is up to and including. |
workingHours_flexibleHoursContract_key |
int32 |
|
☐ |
|
workingHours_flexibleHoursContract_value |
string(50) |
|
☐ |
|
workingHours_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
workingHours_regularWorkPattern |
boolean |
|
☐ |
When the employee works the same amount of hours per day every week, then the workpattern is regular. |
workingHours_shift_bonusPercentage |
decimal |
|
☐ |
The bonus percentage used in wage calculations for the hours made in this shift. |
workingHours_shift_fullTimeHoursPerWeek |
decimal |
|
☐ |
The full time hours for an employment that is linked to this shift. |
workingHours_shift_shiftNumber |
int32 |
|
☐ |
The number for the shift. |
workingHours_shiftRateSickLeave_bonusPercentage |
decimal |
|
☐ |
The bonus percentage used in wage calculations for the hours made in this shift. |
workingHours_shiftRateSickLeave_fullTimeHoursPerWeek |
decimal |
|
☐ |
The full time hours for an employment that is linked to this shift. |
workingHours_shiftRateSickLeave_shiftNumber |
int32 |
|
☐ |
The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte). |
workingHours_startDate |
datetime |
|
☐ |
Start date of the record.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
workingHours_workPattern_evenWeeks_friday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_monday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_saturday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_sunday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_thursday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_tuesday |
double |
|
☐ |
|
workingHours_workPattern_evenWeeks_wednesday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_friday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_monday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_saturday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_sunday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_thursday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_tuesday |
double |
|
☐ |
|
workingHours_workPattern_oddWeeks_wednesday |
double |
|
☐ |
|
13-05-2022 15:37 Version 22.1.40-BETA+3374
