invantive documentation
Invantive Support ForumsLog In / Sign Up

WorkingHoursByWorkingHoursId: Loket.nl REST itgen_loketnl_workinghoursbyworkinghoursid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: WorkingHours
  • Label: itgen_loketnl_workinghoursbyworkinghoursid_plural

Details of the working hours Activity name : GetWorkingHoursByWorkingHoursId

Get the details of a working hours record

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/employees/employments/workinghours/{workinghoursId}
  • Operation: get /providers/employers/employees/employments/workinghours/{workinghoursId}

Parameters

Name Data Type Required Default Documentation
workinghoursId `` The unique identifier of the work detail

Table Columns

The columns of the table WorkingHoursByWorkingHoursId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
aggregatedHoursPerWeek double itgen_loketnl_aggregatedhoursperweek 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.
averageHoursPerWeek double Average Hours per Week 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.
averageParttimeFactor double Average Part-time Factor 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.
calculateUsingWorkPattern_daysDailyRate char itgen_loketnl_calculateusingworkpattern_daysdailyrate 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.
calculateUsingWorkPattern_deviatingDaysAndHours char itgen_loketnl_calculateusingworkpattern_deviatingdaysandhours 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)!
calculateUsingWorkPattern_hoursBrokenPeriod char itgen_loketnl_calculateusingworkpattern_hoursbrokenperiod 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.
calculateUsingWorkPattern_hoursRegularPeriod char itgen_loketnl_calculateusingworkpattern_hoursregularperiod Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
calculateUsingWorkPattern_leaveHours char itgen_loketnl_calculateusingworkpattern_leavehours Indicates whether then leave balances (verlof) are to be calculated based on the workpattern. If set to false and the user is not linked to a leave policy with applyLeaveSchedule set to true the following fields are used for the calculation deviatingHoursPerWeek if null shift.fullTimeHoursPerWeek is used
contractCode_code int32 itgen_loketnl_contractcode_code
contractCode_description varchar2 itgen_loketnl_contractcode_description
contractCode_key guid Contract Code Key The unique identifier of an object (GUID/UUID)
deviatingHoursPerWeek double Deviating Hours per Week 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.
deviatingSvDaysPerPeriod int32 Deviating Social Insurance Days per Period Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value.
endDate datetime End Date The end date of the entity. The date is up to and including.
flexibleHoursContract_key int32 Flexible Hours Contract Key
flexibleHoursContract_value varchar2(50) Flexible Hours Contract Value
id guid ID The unique identifier of an object (GUID/UUID)
regularWorkPattern char Regular Work Pattern When the employee works the same amount of hours per day every week, then the workpattern is regular.
shift_bonusPercentage decimal Shift Bonus Percentage The bonus percentage used in wage calculations for the hours made in this shift.
shift_fullTimeHoursPerWeek decimal Shift Fulltime Hours per Week The full time hours for an employment that is linked to this shift.
shift_shiftNumber int32 Shift Number The number for the shift.
shiftRateSickLeave_bonusPercentage decimal itgen_loketnl_shiftratesickleave_bonuspercentage The bonus percentage used in wage calculations for the hours made in this shift.
shiftRateSickLeave_fullTimeHoursPerWeek decimal itgen_loketnl_shiftratesickleave_fulltimehoursperweek The full time hours for an employment that is linked to this shift.
shiftRateSickLeave_shiftNumber int32 itgen_loketnl_shiftratesickleave_shiftnumber The key number to identify the shift to be used for calculation of daily rate in case of sick leave (ziekte).
startDate datetime Start Date Start date of the record. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
workPattern_evenWeeks_friday double itgen_loketnl_workpattern_evenweeks_friday
workPattern_evenWeeks_monday double itgen_loketnl_workpattern_evenweeks_monday
workPattern_evenWeeks_saturday double itgen_loketnl_workpattern_evenweeks_saturday
workPattern_evenWeeks_sunday double itgen_loketnl_workpattern_evenweeks_sunday
workPattern_evenWeeks_thursday double itgen_loketnl_workpattern_evenweeks_thursday
workPattern_evenWeeks_tuesday double itgen_loketnl_workpattern_evenweeks_tuesday
workPattern_evenWeeks_wednesday double itgen_loketnl_workpattern_evenweeks_wednesday
workPattern_oddWeeks_friday double itgen_loketnl_workpattern_oddweeks_friday
workPattern_oddWeeks_monday double itgen_loketnl_workpattern_oddweeks_monday
workPattern_oddWeeks_saturday double itgen_loketnl_workpattern_oddweeks_saturday
workPattern_oddWeeks_sunday double itgen_loketnl_workpattern_oddweeks_sunday
workPattern_oddWeeks_thursday double itgen_loketnl_workpattern_oddweeks_thursday
workPattern_oddWeeks_tuesday double itgen_loketnl_workpattern_oddweeks_tuesday
workPattern_oddWeeks_wednesday double itgen_loketnl_workpattern_oddweeks_wednesday

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: