---
title: "Payroll component sets"
method: GET
path: "/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponentsets"
tags: ["Payroll component set"]
---

# Payroll component sets

`GET /v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponentsets`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollcomponentsets`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetPayrollComponentSetsByPayrollAdministrationId" target="_blank">GetPayrollComponentSetsByPayrollAdministrationId</a>

Get the payroll components sets that are available at this level.  A payroll component set defines a set of payroll components to be used as a sjabloon preventing the need for users to constantly select the same set of payroll components. Payroll component sets are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens).

## Path parameters

- `payrollAdministrationId` string, uuid, required

## 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` PayrollComponentSetsGetPost[]
    - `id` string, uuid, nullable: The unique identifier of the payroll component set that is to be used as default set when editing payroll periode data for all employments of a payroll administration
    - `description` string
    - `payrollComponents` object[]
      - `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.
      - `description` 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.
        - `key` integer
        - `value` string
      - `deductionOrPayment` object, nullable: Indicates if the value of the payroll component will be deducted from or added to the salary. In case the component is neither a deduction or a payment, NULL is returned.
        - `key` integer
        - `value` string
      - `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.
    - `type` object: The type of the componentset. (Loonresultaten, Werkkosten, VerlofOpbouw)
      - `key` integer
      - `value` string

## 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)