Please enable JavaScript to view this site.

Navigation: Schema: PayrollPeriods > Tables

PayrollPeriodPayrollRunsByPayrollAdministrationId

List of all available payroll periods__Activity name :__ GetPayrollPeriodsByPayrollAdministrationIdReturns a list of all payroll periods available for the given payroll administration

Catalog: LoketNlRest

Schema: PayrollPeriods

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

Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods

Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods

Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods

Field Selection Method: NotRequired

Base Path: _embedded[*].payrollRuns[*]

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

Table Function Parameters

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

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

automaticProcessing_approvePayrollRunOn

datetime

 

The date on which the payroll run for this period is automatically approved (if all prerequisite are met).

automaticProcessing_createPayrollRunOn

datetime

 

The date on which the payroll run for this period is automatically created (if all prerequisite are met).

automaticProcessing_hasAutomaticPayrollRunApprovalBeenExecuted

boolean

 

 

automaticProcessing_hasAutomaticPayrollRunCreationBeenExecuted

boolean

 

 

endDate

datetime

 

The last day of the payroll period

id_1

int32

 

The id for this specific payroll period.

id

guid

 

The unique identifier of an object (GUID/UUID)

payrollPeriodType_key

int32

 

 

payrollPeriodType_value

string(50)

 

 

payrollRunStatus_key

int32

 

The key indicating the current status of the payroll run.

payrollRunStatus_value

string

 

The value describing the current status of the payroll run.

periodNumber

int32

 

The period number of the payroll period

sequenceNumber

int32

 

An incremental number with a payrolling year to uniquely identify a payroll run. Null can be returned for those runs that dont contain "wages".

sequenceNumberApproved

int32

 

An incremental number with a payrolling year to uniquely identify an approved payroll run.

startDate

datetime

 

The first day of the payroll period

testYear

boolean

 

Indicates whether the payroll year is 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.

year

int32

 

The payroll year

 

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