PayrollPeriodDataComponentsByPayrollPeriodDataId: Loket.nl REST itgen_loketnl_payrollperioddatacomponentsbypayrollperioddataid_plural
read only REST
- Catalog:
LoketNlRest - Schema:
PayrollPeriodData - Label: itgen_loketnl_payrollperioddatacomponentsbypayrollperioddataid_plural
Details of a payroll period data Activity name : GetPayrollPeriodDataByPayrollPeriodDataId
Get the details of payroll period data
Can only retrieve data.
API Source
- Endpoint:
/providers/employers/employees/employments/payrollperioddata/{payrollperioddataId} - Operation:
get /providers/employers/employees/employments/payrollperioddata/{payrollperioddataId}
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payrollperioddata |
`` | The unique identifier of the payroll period data |
Table Columns
The columns of the table PayrollPeriodDataComponentsByPayrollPeriodDataId 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) | ||
id |
guid |
ID | The unique identifier of an object (GUID/UUID) | ||
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 |
varchar2 |
Text on Payslip | A custom text to be displayed on the payslip. | ||
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: