LOloket
Benefits and deductions import

Get data to create an importfile

Activity name : <a href="https://developer.loket.nl/Activities/GetBenefitsAndDeductionsImportDataByPayrollAdministrationId" target="_blank">GetBenefitsAndDeductionsImportDataByPayrollAdministrationId</a>

Returns, for the given payrolladministration, a set of data that can be used as a base for importing benefits and deductions through a csv file.

Note that on importing, the columnnames must be in Dutch. (Clientnr, PersnrVerl, Persnr, Naam, Ingangsdatum, Component, Omschrijving, Toeslag )

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/benefitsanddeductions"

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/import/benefitsanddeductions"
  • Auth
    none required

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

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

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "clientNumber": 20720,
      "payrollEmployeeNumber": 202,
      "employeeNumber": 156,
      "formattedName": "Jong, I",
      "startDate": "2023-11-01",
      "payrollComponentKey": 1,
      "payrollComponentDescription": "Uren gewerkt",
      "value": 3500
    }
  ]
}

Changes

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