LOloket
Apg pension declaration

Detail APG pension declaration for an administration

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

Details of APG pension declaration

get/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/apgpensiondeclarations/{apgPensionDeclarationId}
  • Auth
    none required

Path parameters

apgPensionDeclarationIdstring uuid required

The unique identifier of the payroll tax return

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
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "messageReference": "190",
    "methodOfCreation": {
      "key": 2,
      "value": "Individueel"
    },
    "apgPensionDeclarationStatus": {
      "key": 3,
      "value": "Pensioenaangifte aangemaakt"
    },
    "period": {
      "year": 2017,
      "periodNumber": 1,
      "periodId": 202101,
      "periodType": {
        "key": 2,
        "value": "month"
      },
      "periodStartDate": "2021-11-01",
      "periodEndDate": "2021-11-30"
    },
    "withholdingAgentName": "Ben-Hur BV Via Roma",
    "externalParty": {
      "key": 13,
      "value": "PFZW (APG)"
    },
    "requestTime": "2018-05-08T15:16:49+02:00",
    "creationTime": "2018-05-08T15:16:49+02:00",
    "approvalTime": "2018-05-08T15:16:49+02:00",
    "sentTime": "2018-05-08T15:16:49+02:00",
    "removeTime": "2018-05-08T15:16:49+02:00",
    "requestedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "approvedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "removedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "cancelledTime": "2018-05-08T15:16:49+02:00",
    "cancelledBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "responseMessages": [
      {
        "datetimeOfRegistration": "2016-01-19",
        "datetimeOfMessageReceipt": "2016-01-19",
        "description": "Bestand ontvangen"
      }
    ]
  }
}

Changes

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