# PayrollPeriodResultsByEmploymentIdAndYear_ContentPayrollPeriodsPayslipTypesPayrollComponentResults Get payroll period results of an employment for a year __Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYear Download the payroll results (conform overzicht strook) of an employment per payroll period for the provided year. **Please note the following:** There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. __For example:__ the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year) * Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to. * Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from. De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook). One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date. 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: `Payslip` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `employmentId` | `guid` | ☑ | | The unique identifier of the employment | | `year` | `int32` | ☑ | | The payroll year | ## Columns The columns of the table `PayrollPeriodResultsByEmploymentIdAndYear_ContentPayrollPeriodsPayslipTypesPayrollComponentResults` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `employmentId` | `guid` | Employment ID | ☐ | The unique identifier of an object (GUID/UUID) | | `payrollComponent_category_key` | `int32` | Payroll Component Category Key | ☐ | | | `payrollComponent_category_value` | `string` | Payroll Component Category Value | ☐ | | | `payrollComponent_column_key` | `int32` | | ☐ | | | `payrollComponent_column_value` | `string` | | ☐ | | | `payrollComponent_costsEmployer_key` | `int32` | | ☐ | | | `payrollComponent_costsEmployer_value` | `string` | | ☐ | | | `payrollComponent_countAsNormHours` | `boolean` | | ☐ | Indicates whether its value is counted as norm hours (bij bepalen normuren) | | `payrollComponent_hoursIndication` | `boolean` | | ☐ | Only applicable for component in category 6 (eenheden) | | `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 many of them by heart. | | `payrollComponent_value` | `string(14)` | | ☐ | The description of the payroll component | | `payrollPeriod_periodEndDate` | `datetime` | Payroll Period End Date | ☐ | The last day of the period for which the tax return message was created | | `payrollPeriod_periodNumber` | `int32` | Payroll Period Number | ☐ | The period number of the payroll period the record relates to | | `payrollPeriod_periodStartDate` | `datetime` | Payroll Period Start Date | ☐ | The first day of the period for which the tax return message was created | | `payrollPeriod_testYear` | `boolean` | Payroll Processing Period Test Year | ☐ | Indicates whether the payroll periode is part of a test year. In Loket it is possible to run a year of a payrolladministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data. | | `payrollPeriod_year` | `int32` | Payroll Processing Year Period | ☐ | The year of the payroll period the record relates to | | `payslipType_key` | `int32` | Payslip Type Key | ☐ | | | `payslipType_value` | `string` | Payslip Type Value | ☐ | | | `value` | `decimal` | Value | ☐ | Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this. | | `valueSpecialTariff` | `decimal` | Special Rate Value | ☐ | Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time. |