---
title: "Detail UPA pension declaration"
method: GET
path: "/v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}"
tags: ["Upa pension declaration"]
---

# Detail UPA pension declaration

`GET /v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}`

## Request

- Base URL: `https://api.loket.nl`
- URL: `https://api.loket.nl/v2/providers/employers/payrolladministrations/upapensiondeclarations/{upaPensionDeclarationId}`
- Auth: none required

__Activity name :__ <a href="https://developer.loket.nl/Activities/GetUpaPensionDeclarationByUpaPensionDeclarationId" target="_blank">GetUpaPensionDeclarationByUpaPensionDeclarationId</a>

Details of UPA pension declaration

## Path parameters

- `upaPensionDeclarationId` string, uuid, required

## Query parameters

- `filter` string
- `orderBy` string
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Authorization` string, required
- `Accept` string, required

## Response `200`

OK

- object: a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.
  - `version` Version
    - `obsoleteDate` string, date, nullable: The date (can be null) on which the `resourceVersion` is no longer supported/available
    - `resourceVersion` string, date: The resource version of the object in the response
  - `messages` object[]
    - `type` string: Indication of the type of message. See [the general documentation for more information](./#section/Response/Messages)
    - `description` string: Describes the message
    - `id` string, uuid, nullable: In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity
    - `code` integer: Identifying code for the message
    - `properties` string[]: An array that can contain additional information
  - `content` UpaPensionDeclaration
    - `id` string, uuid: The unique identifier of an object (GUID/UUID)
    - `messageReference` string, nullable: The message reference (berichtkenmerk) to recognize the given declaration.
    - `methodOfCreation` object: Method by which the creation of the run was triggered.
      - `key` integer
      - `value` string
    - `payrollTaxesNumber` string, nullable: The payroll tax number, loonheffingennummer, is the number that is used for the Loonaangifte for the Belastingdienst.
    - `upaPensionDeclarationStatus` object: The current status of the pension declaration Possible values: * Verzoek tot aanmaak pensioenaangifte (key = 1) * Fout bij aanmaken pensioenaangifte (key = 2) * Pensioenaangifte aangemaakt (key = 3) * Pensioenaangifte geannuleerd (key = 4) * Pensioenaangifte bevestigd (key = 5) * Pensioenaangifte verzonden (key = 6) * Pensioenaangifte verwijderd (key = 7)
      - `key` integer
      - `value` string
    - `period` object, nullable
      - `year` integer: The year of the period for which the pension declaration was created.
      - `periodNumber` integer: The period number of the payroll period for which the pension declaration was created. In case of a yearly tax return this value will be set to 0
      - `periodId` integer: The periodId of the payroll period.
      - `periodType` object, nullable: Indicates the frequence of the process. Payrolling can be done on a montly, 4-weekly or weekly basis.
        - `key` integer
        - `value` string
      - `periodStartDate` string, date: The start date of the period
      - `periodEndDate` string, date: The end date of the period
    - `withholdingAgentName` string: The withholding agent name (naam inhoudingsplichtige) for this return.
    - `externalParty` object: External party (externe partij)
      - `key` integer
      - `value` string
    - `sendingPartyNumber` string: The number of the sending party (i.e. nummer leverancier).
    - `requestTime` string, date-time: The time at which the payroll run was requested by the user
    - `creationTime` string, date-time, nullable: The time at which the pension message was requested by the user
    - `approvalTime` string, date-time, nullable: The time at which the payroll run was approved by the user
    - `cancelledTime` string, date-time, nullable: The time at which the payroll run was Cancelled by the user
    - `sentTime` string, date-time, nullable: The time at which the pay roll run was sent.
    - `removeTime` string, date-time, nullable: The time at which the pay roll run was removed.
    - `requestedBy` UserBasicNotNullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `approvedBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `cancelledBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `removedBy` UserBasic, nullable
      - `id` string, uuid: The unique identifier of an object (GUID/UUID)
      - `initials` string: The initials of the user
      - `prefix` string, nullable: The prefix of the user
      - `lastName` string: The last name of the user
      - `formattedName` string: preformatted user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\>
    - `responseMessages` object[]
      - `datetimeOfRegistration` string, date-time: The date on which the response message was registered in Loket
      - `datetimeOfMessageReceipt` string, date-time: The date on which the original message was received by the external entity
      - `responseType` object
        - `key` integer
        - `value` string
      - `responseStatus` object
        - `key` integer
        - `value` string
      - `citizenServiceNumber` string, nullable: The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN).
      - `incomeRelationshipNumber` integer: The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment.
      - `employeeNumber` integer: The employee number to uniquely identify an employee within an employer
      - `code` string: The description of the response message
      - `description` string: The description of the response message
      - `descriptionFragment` string: The description of the response message
      - `errorType` string, nullable: If there is an error type then this field contain its value.
      - `lineNumber` integer, nullable: If there is an error type then this field contain a value.
      - `linePosition` integer, nullable: If there is an error type then this field contain a value.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/loket/apis/loket-api.md) - [All operations](https://skmtc.dev/loket/apis/loket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loket/apis/loket-api/revisions/32170564148f?raw)