LOloket
Declarations

List of declarations for the employees of an employer

Changed on

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

Returns a list of declarations for the employments of the employer

get/v2/providers/employers/{employerId}/employees/employments/declarations

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/employees/employments/declarations
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "employmentInformation": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "employeeNumber": 156,
        "firstName": "Susan",
        "formattedName": "Wiel - van Bergen S.L. van de",
        "incomeRelationshipNumber": 12,
        "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
        "payrollAdministration": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "name": "ABC accountants",
          "clientNumber": 1234,
          "description": "Bakker"
        },
        "function": {
          "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Directeur",
          "group": "internal"
        },
        "department": {
          "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "code": 2,
          "description": "Verkoop"
        }
      },
      "payrollComponent": {
        "key": 11,
        "description": "UREN TVT 130%",
        "deviatingDescription": "Uren tijd voor tijd 130%",
        "deductionOrPayment": {
          "key": 2,
          "value": "Betaling"
        },
        "routeType": {
          "key": 1,
          "value": "Snelste"
        }
      },
      "calculatedDistanceByRoutingService": 8,
      "numberOfUnits": 8,
      "numberOfUnitsByAnalysis": 8,
      "declarationDate": "2017-11-01",
      "declarationComment": "Overwerk project X",
      "declarationStatus": {
        "key": 1,
        "value": "Open"
      },
      "dateOfSubmissionByEmployee": "2018-05-08T15:16:49+02:00",
      "dateOfLastChangeByEmployee": "2018-05-08T15:16:49+02:00",
      "processedInPayrollPeriod": {
        "year": 2017,
        "periodNumber": 1,
        "periodStartDate": "2018-01-01",
        "periodEndDate": "2018-01-31"
      },
      "reasonForDeviatingFromCalculatedDistance": "There were some ongoing road works i had to get around",
      "route": [
        {
          "pointOfInterest": {
            "name": "Van Spaendonck Groep"
          },
          "address": {
            "freeformAddress": "Reitseplein 1, 5037 AA Tilburg",
            "countryCode": "NL"
          },
          "position": {
            "latitude": 51.585996,
            "longitude": 5.585996
          }
        }
      ]
    }
  ]
}

Changes

  • b32a42be97f7Revision changes
    • info

      added the optional property /// to the response with the status