LOloket
Upa pension declaration

Initiate a UPA pension declaration

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

Initiate the pension declaration for the next available period for the payrolladministration. Information about the next available periode can be obtained using the defaults endpoint (/defaults)

  • Defaults endpoint can be accessed at the path .../payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiate/defaults.
post/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiate

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/externalparties/{externalPartyKey}/upapensiondeclarations/initiate
  • Auth
    none required

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

externalPartyKeyinteger required
Example:2018

The external party key is used to filter the collection on a specific external party key.

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

Example request

{
  "payrollPeriod": {
    "year": 2024,
    "periodNumber": 1
  }
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}

Changes

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