LOloket
Working hours

Create the working hours for an employment

Activity name : <a href="https://developer.loket.nl/Activities/PostWorkingHoursByEmploymentId" target="_blank">PostWorkingHoursByEmploymentId</a> <br/> <br/> Create a new working hours record for an employment<br/> Please note that so-called chain validation exists for working hours records. In other words, the time periods of records for an employment cannot overlap with each other.<br/> A new or changed startDate affects the endDate of its preceding record.<br/> When POST-ing a new record, the startDate must be greater then the preceding record's startDate.

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.

post/v2/providers/employers/employees/employments/{employmentId}/workinghours

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/workinghours
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

Start date of the record.

A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

endDatestring date nullable

The end date of the entity. The date is up to and including.

deviatingHoursPerWeeknumber double nullable

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.

averageHoursPerWeeknumber double nullable

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.

deviatingSvDaysPerPeriodinteger nullable

Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value.

averageParttimeFactornumber double nullable

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.

regularWorkPatternboolean

When the employee works the same amount of hours per day every week, then the workpattern is regular.

aggregatedHoursPerWeeknumber double nullable

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.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "shift": {
    "shiftNumber": 1,
    "fullTimeHoursPerWeek": 40,
    "bonusPercentage": 12
  },
  "deviatingHoursPerWeek": 32,
  "averageHoursPerWeek": 32,
  "deviatingSvDaysPerPeriod": 20,
  "averageParttimeFactor": 37.5,
  "regularWorkPattern": true,
  "shiftRateSickLeave": {
    "shiftNumber": 1,
    "fullTimeHoursPerWeek": 40,
    "bonusPercentage": 12
  },
  "flexibleHoursContract": {
    "key": 2,
    "value": "Minimum uren contract"
  },
  "workPattern": {
    "oddWeeks": {
      "monday": 8,
      "tuesday": 8,
      "wednesday": 4,
      "thursday": 7.5,
      "friday": 4
    },
    "evenWeeks": {
      "tuesday": 8,
      "wednesday": 8,
      "thursday": 8,
      "friday": 2
    }
  },
  "calculateUsingWorkPattern": {
    "leaveHours": true
  },
  "contractCode": {
    "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "code": 1022,
    "description": "SLA-PT-met toeslagen ATW (88)"
  },
  "aggregatedHoursPerWeek": 24
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "startDate": "2018-01-01",
    "endDate": "2018-10-23",
    "shift": {
      "shiftNumber": 1,
      "fullTimeHoursPerWeek": 40,
      "bonusPercentage": 12
    },
    "deviatingHoursPerWeek": 32,
    "averageHoursPerWeek": 32,
    "deviatingSvDaysPerPeriod": 20,
    "averageParttimeFactor": 37.5,
    "regularWorkPattern": true,
    "shiftRateSickLeave": {
      "shiftNumber": 1,
      "fullTimeHoursPerWeek": 40,
      "bonusPercentage": 12
    },
    "flexibleHoursContract": {
      "key": 2,
      "value": "Minimum uren contract"
    },
    "workPattern": {
      "oddWeeks": {
        "monday": 8,
        "tuesday": 8,
        "wednesday": 4,
        "thursday": 7.5,
        "friday": 4
      },
      "evenWeeks": {
        "tuesday": 8,
        "wednesday": 8,
        "thursday": 8,
        "friday": 2
      }
    },
    "calculateUsingWorkPattern": {
      "leaveHours": true
    },
    "contractCode": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 1022,
      "description": "SLA-PT-met toeslagen ATW (88)"
    },
    "aggregatedHoursPerWeek": 24
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.