Please enable JavaScript to view this site.

Navigation: Schema: PayrollResults > Tables


Get the results of the given payroll period and the one before__Activity name :__ GetComparePayrollPeriodsByPayrollAdministrationId Returns the results of given payroll period and the one before so a comparison can be made. Currently only the components 260, 495, 257 are returned

Catalog: LoketNlRest

Schema: PayrollResults

This is a read-only table function. The (REST) API may not support changing the data or the Invantive SQL driver for (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the (REST) API.

Select (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare

Insert (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare

Update (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare

Delete (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare

Table Function Parameters

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




The unique identifier of the payroll period


Table Function Columns

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


Data Type







The number of employments that where payrolled




The last day of the period for which the tax return message was created




The period number of the payroll period the record relates to




The first day of the period for which the tax return message was created




Indicates whether the payroll periode is part of a test year.In Loket it is possible to run a year of a payrolladministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data.




The year of the payroll period the record relates to


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