LOloket
Year transition

Request year transition collective

Activity name : PostRequestYearTransitionCollectiveByBearerTokenAndYearId

This endpoint allows the user to request a year transition for several payroll administrations. The user can indicate if an email will be sent to the employees and the date on which the employee can access the yearendstatement. During the year transition the given year will be closed and a new year will be opened.

post/year/providers/employers/payrolladministrations/years/{yearId}/requestyeartransition

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/year/providers/employers/payrolladministrations/years/{yearId}/requestyeartransition
  • Auth
    none required

Path parameters

yearIdstring uuid required

The guid of the payroll year

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

payrollAdministrationIdstring uuid

The unique identifier of an object (GUID/UUID)

sentEssMailboolean

Property that indicates if an email will be sent to the employees.

dateAvailableEssstring date nullable

The date on which the employee can access the yearendstatement.

Example request

[
  {
    "payrollAdministrationId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "dateAvailableEss": "2025-04-01"
  }
]

Response

Accepted

Example response

{
  "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.