PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId: Loket.nl REST itgen_loketnl_payrollperiodcomponentsbypayrolladministrationidandpayrollperiodid_plural
read only REST
- Catalog:
LoketNlRest - Schema:
PayrollPeriodDataOnAdministrationLevel - Label: itgen_loketnl_payrollperiodcomponentsbypayrolladministrationidandpayrollperiodid_plural
List of payroll period data on payroll administration level Activity name : GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId
Get 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.
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata - Operation:
get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payroll |
`` | The unique identifier of an administration | ||
payroll |
`` | A predefined category of payroll components to filter which payroll components are returned. Note: Either payroll or payroll or payroll must have a value. |
||
payroll |
`` | A payroll components to filter on. Note: Either payroll or payroll or payroll must have a value. This parameter will soon become available. |
||
payroll |
`` | A predefined set of payroll components to filter which payroll components are returned. Note: Either payroll or payroll or payroll must have a value. |
||
payroll |
`` | The unique identifier of the payroll period | ||
payslip |
`` | Controles which payroll period data is returned either for the normal payslip of the tarif payslip. |
Table Columns
The columns of the table PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
cost |
varchar2 |
Cost Centre Code | |||
cost |
varchar2 |
Cost Centre Description | |||
cost |
int32 |
Cost Centre Key | |||
cost |
varchar2 |
Cost Unit Code | |||
cost |
varchar2 |
Cost Unit Description | |||
cost |
int32 |
Cost Unit Key | |||
distribution |
int32 |
Distribution Unit Code | |||
distribution |
varchar2 |
Distribution Unit Description | |||
distribution |
guid |
Distribution Unit Key | The unique identifier of an object (GUID/UUID) | ||
employee_ |
int32 |
itgen_loketnl_employee_employeenumber | The employee number to uniquely identify an employee within an employer | ||
employee_ |
varchar2 |
Employee First Name | The first name, given name, forename or Christian name as part of a persons personal name. | ||
employee_ |
varchar2 |
Employee Formatted Name | preformated user name for displaying. <lastname>", "<initials>" "<prefix> | ||
employment_ |
guid |
Employment ID | The unique identifier of an object (GUID/UUID) | ||
employment_ |
int32 |
itgen_loketnl_employment_incomerelationshipnumber | 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_ |
int32 |
itgen_loketnl_employment_payrollid | 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. | ||
is |
char |
Is Supplement | 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 payroll. |
||
payroll |
char |
itgen_loketnl_payrollcomponent_canbesupplemented | Indicates whether the atribute for this payroll component can have the value supplement. Refer to the description of the attribute field for an explanation. |
||
payroll |
int32 |
Payroll Component Category Key | |||
payroll |
varchar2 |
Payroll Component Category Value | |||
payroll |
int32 |
itgen_loketnl_payrollcomponent_deductionorpayment_key | |||
payroll |
varchar2 |
itgen_loketnl_payrollcomponent_deductionorpayment_value | |||
payroll |
varchar2 |
Payroll Component Description | The description of the payroll component | ||
payroll |
int32 |
Payroll Component Key | The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart. | ||
payroll |
datetime |
Payroll Period End Date | The last day of the period to which the payroll period data applies | ||
payroll |
int32 |
Payroll Period Number | 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. | ||
payroll |
datetime |
Payroll Period Start Date | The first day of the period to which the payroll period data applies | ||
payroll |
int32 |
Payroll Period Year | The year of the payroll period in which the payroll data is to be processed | ||
payslip |
int32 |
Payslip Type Key | |||
payslip |
varchar2 |
Payslip Type Value | |||
shift_ |
decimal |
Shift Bonus Percentage | The bonus percentage used in wage calculations for the hours made in this shift. | ||
shift_ |
decimal |
Shift Fulltime Hours per Week | The full time hours for an employment that is linked to this shift. | ||
shift_ |
int32 |
Shift Number | The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration. | ||
value |
decimal |
Value | Depending on the selected payroll component the possible value(s) for this field change (dynamic business rules). |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: