---
title: "PayrollPeriodDataByEmploymentId (Loket.nl REST)"
description: "itgen_loketnl_payrollperioddatabyemploymentid_plural"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.PayrollPeriodData.PayrollPeriodDataByEmploymentId
original: https://documentation.invantive.eu/en/datamodels/loketnl/LoketNlRest.PayrollPeriodData.PayrollPeriodDataByEmploymentId
updated: 2024-06-10T18:51:26Z
license: https://documentation.invantive.eu/en/
---

# PayrollPeriodDataByEmploymentId: Loket.nl REST itgen_loketnl_payrollperioddatabyemploymentid_plural

`read only` `REST`

- Catalog: `LoketNlRest`
- Schema: `PayrollPeriodData`
- Label: itgen_loketnl_payrollperioddatabyemploymentid_plural

list of payroll period data
__Activity name :__ GetPayrollPeriodDataByEmploymentId 
 
 Get a list of all payroll period data for an employment. Payroll period data relates to a single payroll period.


Can only retrieve data.

## API Source

- Endpoint: `/providers/employers/employees/employments/{employmentId}/payrollperioddata`
- Operation: `get /providers/employers/employees/employments/{employmentId}/payrollperioddata`

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `employmentId` | `` | [x] |  | The unique identifier of the employment |

## Table Columns

The columns of the table `PayrollPeriodDataByEmploymentId` 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 |
|---|---|---|:---:|---|---|
| `costCenter_code` | `varchar2` | Cost Centre Code | [ ] |  |  |
| `costCenter_description` | `varchar2` | Cost Centre Description | [ ] |  |  |
| `costCenter_key` | `int32` | Cost Centre Key | [ ] |  |  |
| `costUnit_code` | `varchar2` | Cost Unit Code | [ ] |  |  |
| `costUnit_description` | `varchar2` | Cost Unit Description | [ ] |  |  |
| `costUnit_key` | `int32` | Cost Unit Key | [ ] |  |  |
| `distributionUnit_code` | `int32` | Distribution Unit Code | [ ] |  |  |
| `distributionUnit_description` | `varchar2` | Distribution Unit Description | [ ] |  |  |
| `distributionUnit_key` | `guid` | Distribution Unit Key | [ ] |  | The unique identifier of an object (GUID/UUID)  |
| `id` | `guid` | ID | [ ] |  | The unique identifier of an object (GUID/UUID) |
| `payrollPeriod_periodEndDate` | `datetime` | Payroll Period End Date | [ ] |  | The last day of the period to which the payroll period data applies  |
| `payrollPeriod_periodNumber` | `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.  |
| `payrollPeriod_periodStartDate` | `datetime` | Payroll Period Start Date | [ ] |  | The first day of the period to which the payroll period data applies  |
| `payrollPeriod_year` | `int32` | Payroll Period Year | [ ] |  | The year of the payroll period in which the payroll data is to be processed  |
| `payslipText` | `varchar2(25)` | Text on Payslip | [ ] |  | A custom text to be displayed on the payslip.  |
| `payslipType_key` | `int32` | Payslip Type Key | [ ] |  |  |
| `payslipType_value` | `varchar2` | Payslip Type Value | [ ] |  |  |
| `shift_bonusPercentage` | `decimal` | Shift Bonus Percentage | [ ] |  | The bonus percentage used in wage calculations for the hours made in this shift.  |
| `shift_fullTimeHoursPerWeek` | `decimal` | Shift Fulltime Hours per Week | [ ] |  | The full time hours for an employment that is linked to this shift.  |
| `shift_shiftNumber` | `int32` | Shift Number | [ ] |  | The number for the shift. Loket.nl supports a maximum of 5 shifts per payroll administration.  |



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [Loket.nl REST](/en/release-notes/drivers?driver=loket-nl-rest)

