Please enable JavaScript to view this site.

Navigation: Schema: LeaveBalance > Tables

LeaveBalancesByEmploymentId

List of yearly leave balances for each leave type.__Activity name :__ GetLeaveBalancesByEmploymentId Returns the yearly leave balances for each leave type.

Catalog: LoketNlRest

Schema: LeaveBalance

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/employees/employments/{employmentId}/leavebalances

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

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

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

Field Selection Method: NotRequired

Base Path: _embedded[*]

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

Table Function Parameters

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

employmentId

guid

 

The unique identifier of the employment

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

accrual

double

 

The amount of leave units accrued for the leave type in the year

balance

double

 

The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future.

balancePreviousYear

double

 

The remaining leave balance from the previous year for the leave type

leaveType_balanceExceedsYear

boolean

 

Indicates whether the balance at the end of the year for this leave type carries over to the next year.

leaveType_key

int32

 

The key for the leave type.

leaveType_value

string

 

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.

unitType_key

int32

 

The key for the unit type

unitType_value

string

 

The description for the unit type

usageAfterToday

double

 

The amount of leave units used for the leave type in the year after today

usageThroughToday

double

 

The amount of leave units used for the leave type starting from the beginning of the year up to and including today

usageTotal

double

 

The total amount of leave units used for the leave type in the year.

year

int32

 

The year to which the balance of the leave type applies.

 

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