Loket.nl REST API Data Model
BenefitInKindByEmploymentId |
List Benefits in kind__Activity name:__ GetBenefitInKindByEmploymentIdGet a list of the Benefits in kind of the employment.
Catalog: LoketNlRest
Schema: BenefitInKind
Retrieve: true
Insert: true
Update: false
Delete: false
Select loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/benefitsInKind
Insert loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/benefitsInKind
Update loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/benefitsInKind
Delete loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/benefitsInKind
Field Selection Method: NotRequired
Base Path: _embedded[*]
Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/{employmentId}/benefitsInKind
Insert loket.nl (REST) API Operation: post /providers/employers/employees/employments/{employmentId}/benefitsInKind
Table Function Parameters
The following parameters can be used to control the behaviour of the table function BenefitInKindByEmploymentId. 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 BenefitInKindByEmploymentId 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.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
benefitInKindType_description |
string |
|
☐ |
|
benefitInKindType_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
brand |
string(30) |
|
☐ |
The brand of the benefit in kind. |
endDate |
datetime |
End Date |
☐ |
The end date of the entity. The date is up to and including. |
id |
guid |
ID |
☐ |
The unique identifier of an object (GUID/UUID) |
particularities |
string(4000) |
Particularities |
☐ |
Extra information about the benefit in kind |
startDate |
datetime |
Start Date |
☐ |
The date on which this BenefitInKind starts.So multiple Benefits in kind can be active at the same time but one specific BenefitsInKind can never be active multiple times at the same time. |
supplier |
string(30) |
|
☐ |
The supplier of the benefit in kind. |
type |
string(30) |
Type |
☐ |
The type of the benefit in kind. |
value |
decimal |
Value |
☐ |
The value for the selected benefit of kind. |
27-12-2021 11:19 Version 20.2.169-PROD+3633
