--- title: "Get payroll results for the given payroll period" method: GET path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/{payrollPeriodId}/payrollresults" tags: ["Payroll results"] --- # Get payroll results for the given payroll period `GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/{payrollPeriodId}/payrollresults` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollperiods/{payrollPeriodId}/payrollresults` - Auth: none required __Activity name :__ GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId


Returns the payroll results for the payroll period.

__Note :__ This endpoint is related to the `GetPayrollRunResultsByPayrollRunId` endpoint.
Both endpoints return the same output just in a different way. This endpoint returns the current state of the payroll results for the given period where as `GetPayrollRunResultsByPayrollRunId` returns the payroll results for the given payroll run (a payroll run can contain payroll results for multiple payroll periods). It's possible for payroll results to be created after the end of the payroll period it zelf. For example, the payroll periode 01-2020 ends at 31-01-2020 (in case of a monthly payroll period) it is possible that the payroll run for period 07-2020 contains payroll results for the period 01-2020 due to a retroactivity change for that period. This change in the payroll run for payroll period 07-2020 would require the system to reaquire the results for period 01-2020 (as they changed).
## Path parameters - `payrollAdministrationId` string, uuid, required - `payrollPeriodId` integer, required ## Query parameters - `payrollComponents` integer[] - `payrollComponentSet` string, uuid ## Headers - `Authorization` string, required - `Accept` string, required ## Response `200` OK - object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour. - `totalSize` integer: Total number of records, taking into account the given filter. - `pageSize` integer: Number of records in the response - `totalPages` integer: Number of pages available - `currentPage` integer: Current page returned in the response - `version` Version - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available - `resourceVersion` string, date: The resource version of the object in the response - `messages` object[] - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages) - `description` string: Describes the message - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity - `code` integer: Identifying code for the message - `properties` string[]: An array that can contain additional information - `_embedded` PayrollResults2[] - `employmentId` string, uuid: The unique identifier of an object (GUID/UUID) - `payrollPeriods` object[] - `payrollPeriod` object - `year` integer: The year of the payroll period the record relates to - `periodNumber` integer, nullable: The period number of the payroll period the record relates to - `periodStartDate` string, date: The first day of the period for which the tax return message was created - `periodEndDate` string, date: The last day of the period for which the tax return message was created - `testYear` boolean: 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. - `payslipTypes` object[] - `payslipType` object: The type of payslip on which underlying payroll run results will be booked. This is either normaal or bijzonder tarief. - `key` integer - `value` string - `payrollComponentResults` object[] - `payrollComponent` object: A payroll component is the link to the salary calculation. By setting the value of a component the salary calculation will take this value into account when calculating the wage of the employment. `payrollComponent` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer: The number for the payroll component. This number has meaning to payroll professionals using Loket who often know many of them by heart. - `value` string: The description of the payroll component - `category` object: The category of the payroll component. Example categories are, hours/extra hours/net payment/net deduction etc. - … - `column` object: The wage sheet column (kolom) of the payroll component. Kolommen are related to its specific lines on the payslip and/or wage sheet. Also this does bear some similiarties to wage sheets columns (loonstaatkolommen) used by the Belastingdienst, however the division of columns as used by Loket is not identical to that. - … - `costsEmployer` object, nullable: Indicates whether the components are costs for the employer (+) or negative costs (-, i.e. benefit) for the employer. The value could also be NULL meaning that the component is not related to actual expenses. - … - `value` number: Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this. - `valueSpecialTariff` number: 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. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)