Please enable JavaScript to view this site.

Navigation: Schema: Employment > Tables

EmploymentsMinimizedByEmployerId

List of employments with fewer fields for performance reasons__Activity name :__ GetEmploymentsMinimizedByEmployerIdGet a list of employments for an employer. With this version we introduced the "Minimized" resource which contains fewer fields. This version should increase performance when requesting employments for large employer.This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

Catalog: LoketNlRest

Schema: Employment

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/{employerId}/employees/employments/minimized

Insert loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/minimized

Update loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/minimized

Delete loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/minimized

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/employees/employments/minimized

Table Function Parameters

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

employerId

guid

 

The unique identifier of the employer

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

commissionUntilDate

datetime

 

The date on which the employment will end. NL: AanstellingTot

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_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.

employmentDurationType_key

int32

 

 

employmentDurationType_value

string

 

 

endDate

datetime

 

The date on which the employment ends. NL: DatumUitDienst

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. NL: NummerInkomstenVerhouding

nonPayrollAdministration_description

string(50)

 

Description of the administration

nonPayrollAdministration_id

guid

 

The unique identifier of an object (GUID/UUID)

nonPayrollAdministration_name

string(70)

 

Name of the non payroll administration

payrollAdministration_clientNumber

int32

 

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

string(50)

 

Description of the administration

payrollAdministration_id

guid

 

The unique identifier of an object (GUID/UUID)

payrollAdministration_name

string(70)

 

Name of the payroll administration

payrollId

int32

 

The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning

startDate

datetime

 

The date on which this employment starts. NL: DatumInDienst

 

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