invantive documentation
Invantive Support ForumsLog In / Sign Up

LeaveBalancesByEmployerId__embeddedLeaveBalance: Loket.nl REST itgen_loketnl_leavebalancesbyemployerid__embeddedleavebalance_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: LeaveBalance
  • Label: itgen_loketnl_leavebalancesbyemployerid__embeddedleavebalance_plural

The leave balance for all employments Activity name : GetLeaveBalancesByEmployerId

Returns the yearly leave balances for all employments

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/{employerId}/leavebalances
  • Operation: get /providers/employers/{employerId}/leavebalances

Parameters

Name Data Type Required Default Documentation
employerId `` The unique identifier of the employer
referenceDate `` Set a reference date for the following logic 1. To determine the active function and department of the employment 2. To calculate usageAfterToday and usageThroughToday 3. To determine the year for which the leave balance is returned If not provided, "today" is used

Table Columns

The columns of the table LeaveBalancesByEmployerId__embeddedLeaveBalance 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
accrual double itgen_loketnl_accrual The amount of leave units accrued for the leave type in the year
balance double Balance The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.
balancePreviousYear double Balance Previous Year The remaining leave balance from the previous year for the leave type
employee_dateOfBirth datetime Employee Date of Birth The date of birth
employee_employeeNumber int32 itgen_loketnl_employee_employeenumber The employee number to uniquely identify a employee within a employer.
employee_firstName varchar2(28) Employee First Name The first name of the employee
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)
employee_initials varchar2(6) Employee Initials The initials of the employee
employee_lastName varchar2(25) Employee Last Name The last name of the employee
employee_lastNamePartner varchar2(25) itgen_loketnl_employee_lastnamepartner The last name of the partner of the employee
employee_photo varchar2 Employee Photo A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
employee_prefix varchar2(10) Employee Prefix The prefix of the employee
employee_prefixPartner varchar2(10) Employee Prefix Partner The prefix of the partner of the employee
endDate datetime End Date The date on which the employment ends. NL: DatumUitDienst
expires double itgen_loketnl_expires
  • This field is only relevant for the following leave types:
  • Wettelijk verlof: Accrued statutory leave from previous years that expires on July 1 of the selected year.
  • Bovenwettelijk verlof: Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.
  • Verlof: The sum of the two leave types above.
historicalStartDate datetime Historical Start Date 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. NL: HistorischeDatumInDienst
id guid ID The unique identifier of an object (GUID/UUID)
incomeRelationshipNumber int32 itgen_loketnl_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. NL: NummerInkomstenVerhouding
leaveType_balanceExceedsYear char itgen_loketnl_leavetype_balanceexceedsyear Indicates whether the balance at the end of the year for this leave type carries over to the next year.
leaveType_key int32 Leave Type Key The key for the leave type.
leaveType_value varchar2 Leave Type Value The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
nonPayrollAdministration_description varchar2(50) itgen_loketnl_nonpayrolladministration_description Description of the administration
nonPayrollAdministration_id guid itgen_loketnl_nonpayrolladministration_id The unique identifier of an object (GUID/UUID)
nonPayrollAdministration_name varchar2(70) itgen_loketnl_nonpayrolladministration_name Name of the non payroll administration
organizationalEntity_department_code int32 itgen_loketnl_organizationalentity_department_code
organizationalEntity_department_description varchar2 itgen_loketnl_organizationalentity_department_description
organizationalEntity_department_key guid itgen_loketnl_organizationalentity_department_key The unique identifier of an object (GUID/UUID)
organizationalEntity_deviatingFunctionDescription varchar2(50) itgen_loketnl_organizationalentity_deviatingfunctiondescription The deviating function description of the employment. This description deviates from the value of the function field.
organizationalEntity_deviatingFunctionGroup varchar2(5) itgen_loketnl_organizationalentity_deviatingfunctiongroup The deviating function group description of the employment. Only applies when a deviating function description is defined.
organizationalEntity_endDate datetime itgen_loketnl_organizationalentity_enddate The end date of the entity. The date is up to and including.
organizationalEntity_function_description varchar2(50) itgen_loketnl_organizationalentity_function_description
organizationalEntity_function_group varchar2(5) itgen_loketnl_organizationalentity_function_group
organizationalEntity_function_key guid itgen_loketnl_organizationalentity_function_key The unique identifier of an object (GUID/UUID)
organizationalEntity_placeOfEmployment varchar2(24) itgen_loketnl_organizationalentity_placeofemployment The standard working location (standplaats) for the employment.
organizationalEntity_standardFunction_category int32 itgen_loketnl_organizationalentity_standardfunction_category
organizationalEntity_standardFunction_code varchar2(6) itgen_loketnl_organizationalentity_standardfunction_code
organizationalEntity_standardFunction_key int32 itgen_loketnl_organizationalentity_standardfunction_key
organizationalEntity_standardFunction_value varchar2 itgen_loketnl_organizationalentity_standardfunction_value
organizationalEntity_startDate datetime itgen_loketnl_organizationalentity_startdate The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.
payrollAdministration_clientNumber int32 itgen_loketnl_payrolladministration_clientnumber The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.
payrollAdministration_description varchar2(50) itgen_loketnl_payrolladministration_description Description of the administration
payrollAdministration_id guid Payroll Administration ID The unique identifier of an object (GUID/UUID)
payrollAdministration_name varchar2(70) Payroll Administration Name Name of the payroll administration
startDate datetime Start Date The date on which this employment starts. NL: DatumInDienst
usageAfterReferenceDate double itgen_loketnl_usageafterreferencedate The amount of leave units used for the leave type in the year after referenceDate
usageThroughReferenceDate double itgen_loketnl_usagethroughreferencedate The amount of leave units used for the leave type starting from the beginning of the year up to and referenceDate
usageTotal double Usage Total The total amount of leave units used for the leave type in the year.
year int32 Year The year to which the balance of the leave type applies.

Release Notes

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