PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId |
List of payroll period data on payroll administration level__Activity name :__ GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodIdGet a list of all payroll period data for all the active employment in the given payroll period for the give payroll administration. Payroll period data relates to a single payroll period.This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.__Metadata :__ Possible options for the query string parameters can be acquired (GET) via the `/metadata` endpoint. The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata`.__Defaults :__ Default values for the query string parameters can be acquired via the `/defaults` endpoint. The URI for this endpoint is `../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults`.
Catalog: LoketNlRest
Schema: PayrollPeriodDataOnAdministrationLevel
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/{payrollPeriodId}/payrollperioddata
Insert loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Update loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Delete loket.nl (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Field Selection Method: NotRequired
Base Path: _embedded[*].payrollComponents[*]
Select loket.nl (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId. 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 |
payrollComponentCategory |
int32 |
☐ |
|
A predefined category of payroll components to filter which payroll components are returned.__Note:__ Either `payrollComponentSet` or `payrollComponentCategory` must have a value.Mutually exclusive with `payrollComponentSet`. |
payrollComponentSet |
guid |
☐ |
|
A predefined set of payroll components to filter which payroll components are returned.__Note:__ Either `payrollComponentSet` or `payrollComponentCategory` must have a value.Mutually exclusive with `payrollComponentCategory`. |
payrollPeriodId |
int32 |
☑ |
|
The unique identifier of the payroll period |
payslipType |
int32 |
☑ |
|
Controles which payroll period data is returned either for the normal payslip of the tarif payslip. |
Table Function Columns
The columns of the table function PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
costCenter_code |
string |
|
☐ |
|
costCenter_description |
string |
|
☐ |
|
costCenter_key |
int32 |
|
☐ |
|
costUnit_code |
string |
|
☐ |
|
costUnit_description |
string |
|
☐ |
|
costUnit_key |
int32 |
|
☐ |
|
distributionUnit_code |
int32 |
|
☐ |
|
distributionUnit_description |
string |
|
☐ |
|
distributionUnit_key |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
employee_employeeNumber |
int32 |
|
☐ |
The employee number to uniquely identify an employee within an employer |
employee_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
employment_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
employment_incomeRelationshipNumber |
int32 |
|
☐ |
The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment. |
employment_payrollId |
int32 |
|
☐ |
The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. |
isSupplement |
boolean |
|
☐ |
This boolean determines what the salary calculation will do with the value of the payroll component if the payroll component has values in both the payroll period specific data (this endpoint) and in the non-payroll period specific configuration of the employment (it is possible to configure values for payroll components that span multiple payroll periods and even parts thereof).* When set to `false`, the value of the payroll component will overwrite the value specified in the non-payroll period specific data with the given value in the payroll period specific date.* When set to `true`, the value of the payroll period specific data will be added to the value of the non-payroll period specific data. Note that a value can be a negative number. For instance, a payroll period specific value of 20 and a non-payroll period specific value of -8 will effectively result in 12 for salary calculation.This boolean can only be set to `true` in components for which `payrollComponent.canBesupplemented = true`. |
payrollComponent_canBeSupplemented |
boolean |
|
☐ |
Indicates whether the atribute for this payroll component can have the value `supplement`. Refer to the description of the attribute field for an explanation. |
payrollComponent_category_key |
int32 |
|
☐ |
|
payrollComponent_category_value |
string |
|
☐ |
|
payrollComponent_deductionOrPayment_key |
int32 |
|
☐ |
|
payrollComponent_deductionOrPayment_value |
string |
|
☐ |
|
payrollComponent_description |
string(14) |
|
☐ |
The description of the payroll component |
payrollComponent_key |
int32 |
|
☐ |
The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart. |
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]) of the payroll period in which the payroll data is to be processed. |
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 in which the payroll data is to be processed |
payslipType_key |
int32 |
|
☐ |
|
payslipType_value |
string |
|
☐ |
|
shift_bonusPercentage |
decimal |
|
☐ |
The bonus percentage used in wage calculations for the hours made in this shift. |
shift_fullTimeHoursPerWeek |
decimal |
|
☐ |
The full time hours for an employment that is linked to this shift. |
shift_shiftNumber |
int32 |
|
☐ |
The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration. |
value |
decimal |
|
☐ |
Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules). |
13-05-2022 15:37 Version 22.1.40-BETA+3374