Please enable JavaScript to view this site.

Navigation: Schema: PayrollProcessStatus > Tables

PayrollProcessStatusByProviderId

Payroll status for each administration.__Activity name :__ GetPayrollProcessStatusByProviderId__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.__Defaults :__ The default value for payrollPeriod.payrollPeriodId can be acquired by adding `/defaults' to the POST URL. <span style="color:red">========== This endpoint is under development and cannot be used yet. Subscribe to the newsletter to receive updates. ==========</span>Returns an array of objects. Each object contains information about the payroll administration and the payroll processes status.

Catalog: LoketNlRest

Schema: PayrollProcessStatus

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/{providerId}/payrollprocessstatus

Insert loket.nl (REST) API URL: /providers/{providerId}/payrollprocessstatus

Update loket.nl (REST) API URL: /providers/{providerId}/payrollprocessstatus

Delete loket.nl (REST) API URL: /providers/{providerId}/payrollprocessstatus

Field Selection Method: NotRequired

Base Path: _embedded[*]

Select loket.nl (REST) API Operation: get /providers/{providerId}/payrollprocessstatus

Table Function Parameters

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

payrollPeriodId

int32

 

The unique identifier of the payroll period to return

providerId

guid

 

The unique identifier of a provider

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

administrationNumber

string(15)

 

The administration number is a free field commonly used to register the debtors number.

cao_key

int32

 

 

cao_value

string(50)

 

 

clientNumber

int32

 

The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.

employerId

guid

 

The unique identifier of an object (GUID/UUID)

employerLogo

string

 

The location of the logo of the employer. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.

groupClassification_key

int32

 

 

groupClassification_value

string

 

 

groupCode

int64

 

Number (integer) used for grouping administrations.

hasAutomaticPayroll

boolean

 

Indicates whether automatic payrolling is set

id

guid

 

The unique identifier of an object (GUID/UUID)

loonmodel_key

int32

 

 

loonmodel_value

string(50)

 

 

name

string(70)

 

Name of the administration

payrollPeriod_announcements_hasUnreadAnnouncements

boolean

 

Indicates whether the administration has unread announcements

payrollPeriod_notifications_hasUnreadNotifications

boolean

 

Indicates whether the administration has unread notifications

payrollPeriod_payrollPeriodId

int32

 

The year and period of the payroll period

payrollPeriod_payrollProcess_methodOfCreation_key

int32

 

The key indicating how the payroll run was created.

payrollPeriod_payrollProcess_methodOfCreation_value

string

 

The value describing how the payroll run was created.

payrollPeriod_payrollProcess_status_key

int32

 

 

payrollPeriod_payrollProcess_status_value

string

 

 

payrollPeriod_periodEndDate

datetime

 

The last day of the period to which the payroll period data applies

payrollPeriod_periodNumber

int32

 

The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53])

payrollPeriod_periodStartDate

datetime

 

The first day of the period to which the payroll period data applies

payrollPeriod_year

int32

 

The year of the payroll period

payrollPeriodType_key

int32

 

 

payrollPeriodType_value

string(50)

 

 

shortName

string(12)

 

Shortened name of the administration

 

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