Please enable JavaScript to view this site.

Navigation: Schema: Payslip > Tables

PayslipsByEmploymentId

List of payslips for an employment__Activity name :__ GetPayslipsByEmploymentIdGet a list of payslips for the specified employment, including the GUID of the corresponding payroll run.The function of this endpoint is dependent on the role of the user; * For users with the role of 'werknemer'; The endpoint only returns results for payrollruns that have the status 'approved' AND for which results of the payroll are available for ESS (based on the ESS-date of the payrollrun) . * For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the 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}/payslips

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

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

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

Field Selection Method: NotRequired

Base Path: _embedded[*]

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

Table Function Parameters

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

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

approvalTime

datetime

 

The time at which the payslip was approved.

numberOfPayslips

int32

 

The number of different types of payslips for the given payroll period.

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

payrollrunId

guid

 

The unique identifier of an object (GUID/UUID)

 

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