Loket.nl REST API Data Model
ComparePayrollPeriodPayrollComponentResultsByPayrollAdministrationId |
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 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/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare
Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare
Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare
Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/compare
Field Selection Method: NotRequired
Base Path: _embedded[*].payrollComponentResults[*]
Select loket.nl (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 ComparePayrollPeriodPayrollComponentResultsByPayrollAdministrationId. 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 |
|---|---|---|---|---|
payrollAdministrationId |
guid |
☑ |
|
The unique identifier of an administration |
payrollPeriodId |
int32 |
☑ |
|
The unique identifier of the payroll period |
Table Function Columns
The columns of the table function ComparePayrollPeriodPayrollComponentResultsByPayrollAdministrationId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
numberOfPayrolledEmployments |
int32 |
|
☐ |
The number of employments that where payrolled |
payrollComponent_category_key |
int32 |
|
☐ |
|
payrollComponent_category_value |
string |
|
☐ |
|
payrollComponent_column_key |
int32 |
|
☐ |
|
payrollComponent_column_value |
string |
|
☐ |
|
payrollComponent_costsEmployer_key |
int32 |
|
☐ |
|
payrollComponent_costsEmployer_value |
string |
|
☐ |
|
payrollComponent_key |
int32 |
|
☐ |
The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart. |
payrollComponent_value |
string(14) |
|
☐ |
The description of the payroll component |
payrollPeriod_periodEndDate |
datetime |
|
☐ |
The last day of the period for which the tax return message was created |
payrollPeriod_periodNumber |
int32 |
|
☐ |
The period number of the payroll period the record relates to |
payrollPeriod_periodStartDate |
datetime |
|
☐ |
The first day of the period for which the tax return message was created |
payrollPeriod_testYear |
boolean |
|
☐ |
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. |
payrollPeriod_year |
int32 |
|
☐ |
The year of the payroll period the record relates to |
value |
decimal |
|
☐ |
Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this. |
valueSpecialTariff |
decimal |
|
☐ |
Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
