Please enable JavaScript to view this site.

Navigation: » No topics above this level «

PayrollPeriodResultsByEmploymentIdAndYear_ContentPayrollPeriods

Get payroll period results of an employment for a year__Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYearDownload the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.**Please note the following:** There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. __For example:__ the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year)* Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.* Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date.

Catalog: LoketNlRest

Schema: Payslip

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/{employmentId}/payrollperiodresults/year/{year}

Insert loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}

Update loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}

Delete loket.nl (REST) API URL: /providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}

Field Selection Method: NotRequired

Base Path: content.payrollPeriods[*]

Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/{employmentId}/payrollperiodresults/year/{year}

Table Function Parameters

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

year

int32

 

The payroll year

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

employmentId

guid

 

The unique identifier of an object (GUID/UUID)

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

 

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