invantive documentation
Invantive Support ForumsLog In / Sign Up

CalendarLeaveRequestsByEmployerId: Loket.nl REST itgen_loketnl_calendarleaverequestsbyemployerid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: Calendar
  • Label: itgen_loketnl_calendarleaverequestsbyemployerid_plural

List leave requests per employment (for calendar) Activity name : GetCalendarLeaveRequestsByEmployerId

For a calendar, this endpoint return the leave requests calendar items PER specific employment.

Please note: this endpoint only will return calendar items based on leave request with status 'ingediend'.

This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/{employerId}/employees/employments/calendar/leaverequests
  • Operation: get /providers/employers/{employerId}/employees/employments/calendar/leaverequests

Parameters

Name Data Type Required Default Documentation
employerId `` The unique identifier of the employer
endDate `` A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.
startDate `` A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.

Table Columns

The columns of the table CalendarLeaveRequestsByEmployerId 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
department_code int32 Department Code
department_description varchar2 Department Description
department_key guid Department Key The unique identifier of an object (GUID/UUID)
employee_firstName varchar2(28) Employee First Name The first name, given name, forename or Christian name as part of a persons personal name.
employee_formattedName varchar2(82) Employee Formatted Name Formatted name of the employee based on the value of howToFormatLastName
employee_id guid Employee ID The unique identifier of an object (GUID/UUID)
employment_id guid Employment ID The unique identifier of an object (GUID/UUID)
employment_incomeRelationshipNumber int32 itgen_loketnl_employment_incomerelationshipnumber The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment.

Release Notes

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