Please enable JavaScript to view this site.

Navigation: » No topics above this level «


Get a list of protected earnings records__Activity name :__ GetProtectedEarningsByEmploymentIdGet a list of protected earnings records

Catalog: LoketNlRest

Schema: ProtectedEarnings

Retrieve: true

Insert: true

Update: false

Delete: false

Select (REST) API URL: /providers/employers/employees/employments/{employmentId}/protectedearnings

Insert (REST) API URL: /providers/employers/employees/employments/{employmentId}/protectedearnings

Update (REST) API URL: /providers/employers/employees/employments/{employmentId}/protectedearnings

Delete (REST) API URL: /providers/employers/employees/employments/{employmentId}/protectedearnings

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select (REST) API Operation: get /providers/employers/employees/employments/{employmentId}/protectedearnings

Insert (REST) API Operation: post /providers/employers/employees/employments/{employmentId}/protectedearnings

Table Function Parameters

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


Data Type


Default Value





The unique identifier of the employment


Table Function Columns

The columns of the table function ProtectedEarningsByEmploymentId 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.


Data Type







The end date of the record




The unique identifier of an object (GUID/UUID)




Start date of this recordA (broken chain)[./#section/Data/Date-chains] is maintained within this resource.__NOTE :__ at the moment of performing a payroll run it will be checked what record is applicable for protected earning (based on the start- and enddate, not based on the payroll period of the payroll run).




The total amount of net wage that is protected.


13-05-2022 15:37 Version 22.1.40-BETA+3374