# PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId 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`. 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: `PayrollPeriodDataOnAdministrationLevel` ## Parameters of Table Function | 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` or `payrollComponentId` must have a value. | | `payrollComponentId` | `int32` | ☐ | | A payroll components to filter on. __Note:__ Either `payrollComponentSet` or `payrollComponentCategory` or `payrollComponentId` must have a value. This parameter will soon become available. | | `payrollComponentSet` | `guid` | ☐ | | A predefined set of payroll components to filter which payroll components are returned. __Note:__ Either `payrollComponentSet` or `payrollComponentCategory` or `payrollComponentId` must have a value. | | `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. | ## Columns The columns of the table `PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId` 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) | | `employee_employeeNumber` | `int32` | | ☐ | The employee number to uniquely identify an employee within an employer | | `employee_firstName` | `string(28)` | Employee First Name | ☐ | The first name, given name, forename or Christian name as part of a persons personal name. | | `employee_formattedName` | `string` | Employee Formatted Name | ☐ | preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> | | `employment_id` | `guid` | Employment ID | ☐ | 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` | 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 | | `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). |