# PayrollPeriodComponentsByEmploymentId 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. This is a read-only table function. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `PayrollPeriodData` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `employmentId` | `guid` | ☑ | | The unique identifier of the employment | ## Columns The columns of the table `PayrollPeriodComponentsByEmploymentId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `costCenter_code` | `string` | Cost Centre Code | ☐ | | | `costCenter_description` | `string` | Cost Centre Description | ☐ | | | `costCenter_key` | `int32` | Cost Centre Key | ☐ | | | `costUnit_code` | `string` | Cost Unit Code | ☐ | | | `costUnit_description` | `string` | Cost Unit Description | ☐ | | | `costUnit_key` | `int32` | Cost Key Code | ☐ | | | `distributionUnit_code` | `int32` | Distribution Unit Code | ☐ | | | `distributionUnit_description` | `string` | Distribution Unit Description | ☐ | | | `distributionUnit_key` | `guid` | Distribution Unit Key | ☐ | The unique identifier of an object (GUID/UUID) | | `employmentId` | `guid` | Employment ID | ☑ | | | `id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `isSupplement` | `boolean` | 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 `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` | Payroll Component Category Key | ☐ | | | `payrollComponent_category_value` | `string` | Payroll Component Category Value | ☐ | | | `payrollComponent_deductionOrPayment_key` | `int32` | | ☐ | | | `payrollComponent_deductionOrPayment_value` | `string` | | ☐ | | | `payrollComponent_description` | `string(14)` | Payroll Component Description | ☐ | The description of the payroll component | | `payrollComponent_key` | `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. | | `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 Processing Year Period | ☐ | The year of the payroll period in which the payroll data is to be processed | | `payrollPeriodDataId` | `guid` | | ☑ | | | `payslipText` | `string(25)` | Text on Payslip | ☐ | A custom text to be displayed on the payslip. | | `payslipType_key` | `int32` | Payslip Type Key | ☐ | | | `payslipType_value` | `string` | Payslip Type Value | ☐ | | | `shift_bonusPercentage` | `decimal` | Service Bonus Percentage | ☐ | The bonus percentage used in wage calculations for the hours made in this shift. | | `shift_fullTimeHoursPerWeek` | `decimal` | Weekly Hours Full-Time Employment | ☐ | The full time hours for an employment that is linked to this shift. | | `shift_shiftNumber` | `int32` | Service 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). |