LOloket
Payroll component set

Payroll component sets

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

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "description": "Standaard exportset",
      "payrollComponents": [
        {
          "key": 1,
          "description": "Uren gewerkt",
          "category": {
            "key": 1,
            "value": "Uren"
          },
          "deductionOrPayment": {
            "key": 2,
            "value": "Betaling"
          }
        }
      ],
      "type": {
        "key": 1,
        "value": "Loonresultaten"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.