Employment
List of employments with additional entities
Activity name : <a href="https://developer.loket.nl/Activities/GetEmploymentsComprehensiveByEmployerId" target="_blank">GetEmploymentsComprehensiveByEmployerId</a>
Availability: This is endpoint is available for the Loket application only. It is not available for external parties
Get a list of employments for an employer. With this version we introduced the "Comprehensive" resource which contains additional entities.
This endpoint only returns the employments that meet the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.
get/v2/providers/employers/{employerId}/employees/employments/comprehensive
Request
- Base URLhttps://api.loket.nl
- URLhttps://api.loket.nl/v2/providers/employers/{employerId}/employees/employments/comprehensive
- Authnone required
Path parameters
employerIdstring uuid required
The unique identifier of the employer
Query parameters
referenceDatestring date
Example:2022-01-01
Set a reference date for choosing the date dependent data.
removeEmptyLinesboolean
Example:true
When true and combined with a X-ReportInput header, the output only contains employments for which selected underlying data, such as wage, is available.
includeHistoricAndFutureDataboolean
Example:true
If set to true, historic and future records will also be returned
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
{
"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": [
{
"employee": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"employeeNumber": 156,
"personalDetails": {
"firstName": "Susan",
"lastName": "Bergen",
"prefix": "van",
"initials": "S.L.",
"lastNamePartner": "Wiel",
"prefixPartner": "van de",
"formattedName": "Wiel - van Bergen S.L. van de",
"dateOfBirth": "1995-05-21",
"placeOfBirth": "Amsterdam",
"aowDate": "2062-08-21",
"photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}",
"howToFormatLastName": {
"key": 2,
"value": "last name + last name partner"
},
"title": {
"key": 2,
"value": "e.g. Msc, PHD or Baron"
},
"nationality": {
"key": 2,
"value": "Dutch"
},
"gender": {
"key": 2,
"value": "female"
},
"civilStatus": {
"key": 2,
"value": "Maried"
}
},
"contactInformation": {
"phoneNumber": "+31 13-1234567",
"mobilePhoneNumber": "+31 6-1231456",
"faxNumber": "+31 13-1234561",
"emailAddress": "info@loket.nl",
"businessPhoneNumber": "+31 13-1234567",
"businessMobilePhoneNumber": "+31 6-1231456",
"businessEmailAddress": "info@loket.nl"
},
"identityDocument": {
"typeOfDocument": {
"key": 2,
"value": "Passport"
},
"documentIdentification": "CRE45553433"
},
"travel": {
"travelDistanceToWork": 32,
"travelDistanceToWorkInKm": 41.05
},
"address": {
"street": "Voordijk",
"city": "Leiden",
"houseNumber": 12,
"houseNumberAddition": "D",
"furtherIndication": {
"key": 1,
"value": "WW"
},
"postalCode": "1234 AA",
"location": "Fourth floor or building C",
"country": {
"key": 1,
"value": "Netherlands",
"isoCode": "NL"
}
},
"deviatingPostalAddress": {
"street": "Voordijk",
"city": "Leiden",
"houseNumber": 12,
"houseNumberAddition": "D",
"furtherIndication": {
"key": 1,
"value": "WW"
},
"postalCode": "1234 AA",
"location": "Fourth floor or building C",
"country": {
"key": 1,
"value": "Netherlands",
"isoCode": "NL"
}
},
"statusEmployeeSelfService": {
"key": 2,
"value": "Blocked"
},
"revokeEmployeeSelfServiceAccessOn": "2018-10-23"
},
"employment": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"historicalStartDate": "2012-05-01",
"commissionUntilDate": "2019-01-01",
"endDate": "2018-10-23",
"endOfEmploymentReason": {
"key": 1,
"value": "VUT"
},
"endOfEmploymentReasonTaxAuthorities": {
"key": 1,
"value": "Beëindiging arbeidsovereenkomst met wederzijds goedvinden op initiatief van de werkgever."
},
"payrollAdministration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"name": "ABC accountants",
"clientNumber": 1234,
"description": "Bakker"
},
"nonPayrollAdministration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"name": "HR only employees",
"description": "Bakker"
},
"administration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"name": "ABC accountants",
"clientNumber": 1234,
"description": "Bakker"
},
"typeOfEmployee": {
"key": 1,
"value": "Werknemer"
},
"employmentCategoryType": {
"key": 1,
"value": "Ouderschapsverlof"
},
"linkedEmployment": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"employmentDurationType": {
"key": 1,
"value": "Contract of indefinite duration"
},
"startDateContractOfIndefiniteDuration": "2018-05-08",
"employmentContractType": {
"key": 1,
"value": "Arbeidsovereenkomst (excl BBL)"
},
"vacationCoupons": {
"key": 1,
"value": "n.v.t."
},
"sendToExternalParty": {
"key": 1,
"value": "n.v.t."
},
"deviatingCLAExternalParty": 2,
"deviatingCLATaxReturn": 2,
"incomeRelationshipNumber": 12,
"employeeProfileId": {
"key": 1,
"value": "Profiel full-timers"
},
"professionCode": 4,
"typeOfParticipation": {
"value": "n.vt."
},
"valueOfParticipation": {
"value": "n.v.t."
},
"essMutationSet": {
"key": 1,
"value": "Standaard"
},
"exemptionInsuranceObligation": {
"value": "Geen uitzondering."
},
"specialIncomeRatio": {
"value": "n.v.t."
},
"emailLeaveRequest": "api@loket.nl",
"temporaryTaxExemption": {
"key": 2,
"value": "Nee."
},
"periodPayGradeAdjustment": 2,
"commissionUntilDate1": "2018-05-31",
"commissionUntilDate2": "2018-05-31",
"commissionUntilDate3": "2018-05-31",
"commissionUntilDate4": "2018-05-31",
"commissionUntilDate5": "2018-05-31",
"commissionUntilDate6": "2018-05-31",
"isOnCallEmployment": true,
"hasOnCallAppearanceObligation": true,
"isGemoedsbezwaardNationalInsurance": true,
"isGemoedsbezwaardEmployeeInsurance": true,
"isAnonymousEmployee": true,
"cancellationPeriodEmployee": 1,
"cancellationPeriodEmployer": 1,
"cancellationPeriodTimeUnit": {
"key": 4,
"value": "Maand(en)"
},
"cancellationNoticeDate": "2018-05-31",
"startCancellationNoticePeriod": "2018-06-01",
"payrollId": 2,
"namePayslip": "Steve Jobs",
"calculateWorkingHours": true,
"writtenEmploymentContract": true
},
"workinghours": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"shift": {
"shiftNumber": 1,
"fullTimeHoursPerWeek": 40,
"bonusPercentage": 12
},
"deviatingHoursPerWeek": 32,
"averageHoursPerWeek": 32,
"deviatingSvDaysPerPeriod": 20,
"averageParttimeFactor": 37.5,
"regularWorkPattern": true,
"shiftRateSickLeave": {
"shiftNumber": 1,
"fullTimeHoursPerWeek": 40,
"bonusPercentage": 12
},
"flexibleHoursContract": {
"key": 2,
"value": "Minimum uren contract"
},
"workPattern": {
"oddWeeks": {
"monday": 8,
"tuesday": 8,
"wednesday": 4,
"thursday": 7.5,
"friday": 4
},
"evenWeeks": {
"tuesday": 8,
"wednesday": 8,
"thursday": 8,
"friday": 2
}
},
"calculateUsingWorkPattern": {
"leaveHours": true
},
"contractCode": {
"key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"code": 1022,
"description": "SLA-PT-met toeslagen ATW (88)"
},
"aggregatedHoursPerWeek": 24
},
"organizationalEntity": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"function": {
"key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"description": "Directeur",
"group": "internal"
},
"deviatingFunctionGroup": "9A",
"deviatingFunctionDescription": "Directeur",
"standardFunction": {
"key": 1,
"value": "Administrateur",
"code": "A21",
"category": 1
},
"department": {
"key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"code": 2,
"description": "Verkoop"
},
"distributionUnit": {
"key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"code": 2,
"description": "Sales"
},
"placeOfEmployment": "Amsterdam office",
"internalTelephoneExtensionNumber": "678"
},
"wage": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "1995-05-21",
"payrollPeriodType": {
"key": 1,
"value": "Maand"
},
"grossWage": 2300,
"grossWageType": {
"key": 2,
"value": "hourly"
},
"isGrossWageFullTime": true,
"netWage": 2400,
"netWageType": {
"key": 1,
"value": "hourly"
},
"employerCosts": 3500,
"employerCostsType": {
"key": 1,
"value": "hourly"
},
"payScale": {
"key": 1,
"value": "Glastuinbouw maand, Loongebouw A"
},
"payGrade": {
"key": 1,
"value": "Schaal B1, 15 jaar"
},
"applyPayGrade": true
},
"socialSecurityBenefits": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"supplementation": {
"type": {
"key": 3,
"value": "Suppleren (bruto)"
},
"percentage": 35
},
"benefit": {
"type": {
"key": 1,
"value": "ZW eigen risico"
},
"percentage": 35
}
}
],
"socialSecurityConfiguration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"isInsuredForSicknessBenefitsAct": true,
"isInsuredForUnemploymentInsuranceAct": true,
"isInsuredForOccupationalDisabilityInsuranceAct": true
},
"deviatingAwfContribution": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2018-01-01",
"periodEndDate": "2018-01-31"
},
"endPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2018-01-01",
"periodEndDate": "2018-01-31"
},
"typeOfDeviatingAwfContribution": {
"key": 2,
"value": "Hoog"
}
},
"citizenServiceNumber": {
"citizenServiceNumber": "042168588"
},
"employmentCustomFields": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"customField": {
"id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"description": "Shoe size"
},
"value": "41"
}
],
"employeeCustomFields": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"customField": {
"id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
"description": "Shoe size"
},
"value": "41"
}
],
"paymentInformationSepa": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"payrollComponent": {
"key": 260,
"value": "NETTOLOON"
},
"iban": "NL52ABNA0424968264",
"bic": "AUDFDE21",
"visibleOnPayslip": true,
"nameBeneficiary": "Ben Hur",
"cityBeneficiary": "Rome",
"description1": "xx",
"description2": "x"
}
],
"fiscalProperties": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"annualSalary": 60000,
"deviatingTaxTableCode": {
"key": 1,
"value": "999 Overige gevallen waarin geen tabel is toegepast"
},
"deviatingPayrollTaxTableColour": {
"key": 2,
"value": "Werknemer belastingpl. en niet premiepl. WLZ"
},
"deviatingPayrollTaxPercentage": 25,
"applyDeviatingPayrollTaxPercentageOn": {
"key": 2,
"value": "Afwijkend voor tabel- en tariefloon"
},
"applyPayrollTaxDeduction": true,
"residentOf": {
"key": 2,
"value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
},
"applySalarysplit": {
"key": 2,
"value": "LB obv wereldinkomen (%NL/WI)"
},
"percentageForeignIncome": 50,
"deviatingCalculationRulePayrollTax": {
"key": 2,
"value": "Werknemer belastingpl. en niet premiepl. WLZ"
},
"thirtyPercentFacility": {
"key": 1,
"value": "Netto"
},
"deviatingPercentageThirtyPercentFacility": 20.2345,
"contributionReductionEducation": {
"key": 2,
"value": "4. Opleiding hbo"
},
"specialIndication": {
"one": 1,
"two": 1,
"three": 1,
"four": 1
}
},
"healthcareInsuranceActConfiguration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"healthcareInsuranceActType": {
"key": 2,
"value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
},
"additionalContributionEmployer": 320,
"nominalPremium": 320,
"additionalPremium": 120
},
"benefitsInKind": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"benefitInKindType": {
"id": "36530F13-59EB-4C15-B5F2-4F92B070A208",
"description": "Mobiele telefoon"
},
"brand": "Apple",
"type": "Iphone 11",
"value": 1100,
"supplier": "Mediamarkt",
"particularities": "geen bijzonderheden"
}
],
"companyCars": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2021-01-01",
"endDate": "2023-10-23",
"brand": "Volvo",
"model": "V60",
"licensePlateNumber": "GP586D",
"fuelCardNumber": "B100.323.903",
"leaseOrBuy": {
"key": 1,
"value": "Koop"
},
"supplier": "Leasemaatschappij Tilburg",
"lease": {
"startDate": "2021-01-01",
"endDate": "2023-10-23",
"contractNumber": "2021.323.903"
},
"catalogValue": 20000,
"kilometersPrivateUse": 10000,
"comments": "This car is very nice"
}
],
"fiscalCompanyCars": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2021-01-01",
"endDate": "2023-10-23",
"licensePlateNumber": "GP586D",
"dateOfFirstAdmission": "2018-01-01",
"valueForTaxPurposes": 20000,
"additionalTaxLiabilityGroup": {
"key": 1,
"value": "Standaard tarief (25% tot 2017)"
},
"reasonForNoAdditionalTaxLiability": {
"key": 1,
"value": "(2) Werknemer heeft beschikking belastingdienst"
},
"deviatingAdditionalTaxLiability": 20000,
"taxableBenefitForPrivateUse": 2000
}
],
"journalAllocation": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"journalProfileConfiguration": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2017-01-01",
"periodEndDate": "2017-01-31"
},
"endPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2017-01-01",
"periodEndDate": "2017-01-31"
},
"journalProfile": {
"key": 2,
"value": "General ledger supermarkets"
}
},
"startPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2018-01-01",
"periodEndDate": "2018-01-31"
},
"endPeriod": {
"year": 2017,
"periodNumber": 1,
"periodStartDate": "2018-01-01",
"periodEndDate": "2018-01-31"
},
"allocationBasedOnActualHours": {
"costCenter": {
"key": 2,
"code": "SAL073",
"description": "Sales Den Bosch"
},
"costUnit": {
"key": 2,
"code": "01",
"description": "Cars"
}
},
"allocationBasedOnFixedWeights": [
{
"costCenter": {
"key": 2,
"code": "SAL073",
"description": "Sales Den Bosch"
},
"costUnit": {
"key": 2,
"code": "01",
"description": "Cars"
},
"weight": 1
}
]
},
"basesForCalculation": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"deviations": {
"percentage": 8,
"reservationPercentage": 12.0007,
"financialReservationPercentage": 10.000007
},
"ageBasedMinimum": {
"key": 2,
"value": "Toepassen hoogste leeftijd"
},
"ageBasedMaximum": {
"key": 2,
"value": "Toepassen hoogste leeftijd"
},
"base": {
"key": 545,
"value": "VAKANTIE TOESLAG, periodieke opbouw"
}
}
],
"otherPayrollVariables": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"productivityPercentage": 100,
"payrollProperties": {
"deviatingPremiumGroup": {
"key": 2,
"value": "(1) Agrarisch bedrijf kort"
},
"wageCostBenefit": {
"key": 2,
"value": "LKV herplaatsen arbeidsgehandicapte werknemer"
},
"phaseClassification": {
"key": 2,
"value": "(38) Fase A zonder uitzendbeding met uitsluiting van ldv"
},
"incidentalIncomeDeduction": {
"key": 2,
"value": "Bevalling of zwangerschap"
},
"terminateIncomenumberFlexibleEmployment": {
"key": 2,
"value": "(1) Einde werk/contract, geen werk aangeboden"
},
"occupationalDisabilityPremiumDiscount": {
"key": 2,
"value": "(7) Werknemer van 62, 63 of 64 jaar voor wie code 6 niet van toepassing is"
},
"occupationalDisabilityDeductionAfter2009": 1,
"occupationalDisabilityDeductionTo2009": 1,
"collectiveLaborAgreementCodeHiringEmployer": {
"key": 151,
"value": "TUINBOUWVEILINGEN",
"startDate": "2018-01-01",
"endDate": "2018-10-23"
}
},
"pensionProperties": {
"annualCalculationBaseAbp": 1.5,
"leaveAbp": {
"leaveType": {
"key": 2,
"value": "Politiek verlof"
},
"valueOfParticipationDuringLeave": 1
},
"deviatingDisabilityInsuranceActPercentageForCordares": {
"key": 2,
"value": "15- 25 %"
},
"compulsoryEducationDays": 2,
"occupationalPensionFund": 2,
"specificationOfIncomeRelationshipApg": {
"key": 1,
"value": "Geen bijzonderheden",
"code": "WNE"
}
}
},
"paymentinformationNonSepa": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"payrollComponent": {
"key": 260,
"value": "NETTOLOON"
},
"bankAccountNumber": "0403830171874018",
"beneficiary": {
"name": "Ben Hur",
"city": "Rome",
"address": "Via Roma 3",
"country": {
"key": 1,
"value": "Netherlands",
"isoCode": "NL"
}
},
"bank": {
"bankIdentifierCode": "AUDFDE21",
"name": "Ben Hur",
"city": "Rome",
"address": "Via Roma 3",
"country": {
"key": 1,
"value": "Netherlands",
"isoCode": "NL"
}
}
}
],
"basesForEmploymentFundCalculation": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"origin": {
"key": 1,
"value": "Normale wijziging"
},
"base": 25000
}
],
"pensionBenefits": {
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"payout": 2569
},
"deviatingHourlyWages": [
{
"id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
"startDate": "2018-01-01",
"endDate": "2018-10-23",
"payrollComponent": {
"key": 70,
"description": "LOON/SALARIS"
},
"value": 50.87
}
]
}
]
}Changes
No recorded changes to this operation across all 6 revisions of this API.