Employee import

Import employee via a csv file

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

Imports a csv file containing employee records.

post/v2/providers/employers/payrollAdministrations/{payrollAdministrationId}/import/employees

Request

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

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

Query parameters

yearinteger required

The year of the period the data will be imported in.

periodinteger required

The period the data will be imported in.

payslipTypeinteger required

The paysliptype to import the data in.

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

Request body

mimeType'text/csv'

The type of file to import. Currently only csv is supported

datastring

base64 encoded file.

Example request

{
  "data": "YQ=="
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "collectiveActionId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "collectiveActionParentId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedByUserId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "submittedOn": "2023-05-08T15:16:49+02:00",
    "itemCount": {
      "processedWithError": 10,
      "processed": 75,
      "processedWithWarning": 15,
      "total": 100
    }
  }
}

Changes

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