Loket.nl REST API Data Model
WageByWageId |
Details of a single wage__Activity name :__ GetWageByWageIdGet the details of a single wage
Catalog: LoketNlRest
Schema: Wage
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/wages/{wageId}
Insert loket.nl (REST) API URL: /providers/employers/employees/employments/wages/{wageId}
Update loket.nl (REST) API URL: /providers/employers/employees/employments/wages/{wageId}
Delete loket.nl (REST) API URL: /providers/employers/employees/employments/wages/{wageId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/wages/{wageId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function WageByWageId. 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 |
|---|---|---|---|---|
wageId |
guid |
☑ |
|
The unique identifier of a wage |
Table Function Columns
The columns of the table function WageByWageId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
applyPayGrade |
boolean |
|
☐ |
Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. |
employerCosts |
double |
|
☐ |
The cost for the employer for this employee. |
employerCostsType_key |
int32 |
|
☐ |
|
employerCostsType_value |
string(50) |
|
☐ |
|
endDate |
datetime |
|
☐ |
The end date for the information in the record. |
grossWage |
double |
|
☐ |
The gross wage for the employee |
grossWageType_key |
int32 |
|
☐ |
|
grossWageType_value |
string(50) |
|
☐ |
|
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
isGrossWageFullTime |
boolean |
|
☐ |
Indicates whether the given grossWage is either a full-time wage or a part-time wage. Full-time wage is the default value (isGrossWageFulltime = true) and Loket.nl recommends to use this option. A full-time wage takes into account the part-time percentage of an employment. While a part-time wage does not. E.g. A full-time wage of 2400 euro’s is registered. The employments works 20 out of 40 hours (40 fours is a full-time shift) thus having a 20/40 = 50% part-time percentage. The part-time hours (deviatingHoursPerWeek) are accessible through the endpoint for working hours of an employement. In the wage calculation Loket.nl will divide the grossWage component by 50% resulting in a grossWage of 1200 euro’s. In the case of a part-time wage the part-time percentage will be ignored. |
netWage |
double |
|
☐ |
Net wage for the employment |
netWageType_key |
int32 |
|
☐ |
|
netWageType_value |
string(50) |
|
☐ |
|
payGrade_key |
int32 |
|
☐ |
|
payGrade_value |
string(50) |
|
☐ |
|
payrollPeriodType_key |
int32 |
|
☐ |
|
payrollPeriodType_value |
string(50) |
|
☐ |
|
payScale_key |
int32 |
|
☐ |
|
payScale_value |
string(50) |
|
☐ |
|
startDate |
datetime |
|
☐ |
The start date for the information in the record.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.__Note__ It is posible to have no wage record. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
