Please enable JavaScript to view this site.

Navigation: Schema: LeavePolicyAndEmploymentLinks > Tables

EmploymentsByLeavePolicyId

Get list of linked employments for the leave policy__Activity name:__ GetEmploymentsByLeavePolicyIdGet the list of employments that are linked for this leave policy.When a leave policy and an employment are linked, that means the employment will be provided with leave based on the policy.

Catalog: LoketNlRest

Schema: LeavePolicyAndEmploymentLinks

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/leavepolicies/{leavePolicyId}/employments

Insert loket.nl (REST) API URL: /providers/employers/leavepolicies/{leavePolicyId}/employments

Update loket.nl (REST) API URL: /providers/employers/leavepolicies/{leavePolicyId}/employments

Delete loket.nl (REST) API URL: /providers/employers/leavepolicies/{leavePolicyId}/employments

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/employers/leavepolicies/{leavePolicyId}/employments

Table Function Parameters

The following parameters can be used to control the behaviour of the table function EmploymentsByLeavePolicyId. 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

leavePolicyId

guid

 

The unique identifier of the leave policy

 

Table Function Columns

The columns of the table function EmploymentsByLeavePolicyId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

employee_dateOfBirth

datetime

 

The date of birth

employee_employeeNumber

int32

 

The employee number to uniquely identify a employee within a employer.

employee_firstName

string(28)

 

The first name of the employee

employee_formattedName

string(82)

 

Formatted name of the employee based on the value of `howToFormatLastName`

employee_id

guid

 

The unique identifier of an object (GUID/UUID)

employee_initials

string(6)

 

The initials of the employee

employee_lastName

string(25)

 

The last name of the employee

employee_lastNamePartner

string(25)

 

The last name of the partner of the employee

employee_photo

string

 

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

string(10)

 

The prefix of the employee

employee_prefixPartner

string(10)

 

The prefix of the partner of the employee

endDate

datetime

 

The date on which this employment ends.

id

guid

 

The unique identifier of an object (GUID/UUID)

incomeRelationshipNumber

int32

 

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.

startDate

datetime

 

The date on which this employment starts.

 

25-05-2022 14:15 Version 22.1.46-BETA+3385