--- title: "Details of an employment" method: GET path: "/v2/providers/employers/employees/employments/{employmentId}" tags: ["Employment"] --- # Details of an employment `GET /v2/providers/employers/employees/employments/{employmentId}` ## Request - Base URL: `https://api.loket.nl` - URL: `https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}` - Auth: none required __Activity name :__ GetEmploymentByEmploymentId Get the details for an employment ## Path parameters - `employmentId` string, uuid, required ## 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` EmploymentResponseWithClaAndWageModel20191216 - `employee` EmployeeBasic - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `employeeNumber` integer: The employee number to uniquely identify a employee within a employer. - `firstName` string, nullable: The first name of the employee - `initials` string: The initials of the employee - `prefix` string, nullable: The prefix of the employee - `lastName` string: The last name of the employee - `prefixPartner` string, nullable: The prefix of the partner of the employee - `lastNamePartner` string, nullable: The last name of the partner of the employee - `formattedName` string: Formatted name of the employee based on the value of `howToFormatLastName` - `dateOfBirth` string, date: The date of birth - `photo` string, url, nullable: A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `startDate` string, date: The date on which this employment starts. NL: DatumInDienst - `historicalStartDate` string, date, nullable: The historical date on which the employee was first employed. This field is used when an employee has multiple employments in time. In most cases this field should be used as the date on which the employee started working for the company. NL: HistorischeDatumInDienst - `commissionUntilDate` string, date, nullable: The date on which the employment will end. NL: AanstellingTot - `endDate` string, date, nullable: The date on which the employment ends. NL: DatumUitDienst - `endOfEmploymentReason` EndOfEmploymentReason2, nullable: The reason for the end of the employment. NL: RedenEindeDienstverband __Note:__ as of 2020-01-01 `endOfEmploymentReasonTaxAuthorities` replaces this field as the main reason for the end of the employment. We say 'main reason' as in certain cases this field still has a purpose. Please set this field to 8 (Others) unless one of the following integrations is used for this employment * UPA-pensioenaangifte * Cordares * APG-pensioenaangifte * Achmea - `key` integer: The key for the reason for the end of the employment. - `value` string: The description of the reason for the end of the employment. - `endOfEmploymentReasonTaxAuthorities` EndOfEmploymentReasonTaxAuthorities2, nullable: The reason for the end of the employment as specified by the Dutch Tax authorties. NL: RedenEindeDienstverbandAangifte __Note:__ This field replaces `endOfEmploymentReason` as of 2020-01-01. `endOfEmploymentReason` will remain as a field in the resource as several integration require this field still. - `key` integer: The key for the reason for the end of the employment. - `value` string: The description of the reason for the end of the employment. - `endOfEmploymentDueToIllness` boolean, nullable: Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst - `firstDayNotification` boolean, nullable: Indicates whether a first-day notification (EersteDagsMelding) was created for the employment. Attention: this indication cannot be altered after an employment has been created. NL: EersteDagsMelding - `payrollAdministration` PayrollAdministrationWithClaAndWageModel20191216, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `clientNumber` integer: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `description` string: Description of the administration - `cla` object: The CAO (CLA -> collective labor agrement) of the "loonmodel" the payroll administration is linked to. - `value` string - `wageModel` object: The "loonmodel" (this is a Loket term) the payroll administration inherits the payrolling configuration from. Deviating from the loonmodel configuration on payrol administration level is possible. `loonmodel` is a metadata field within the provider context. Possible values can be managed by the user. - `value` string - `nonPayrollAdministration` NonPayrollAdministration20191216, nullable: Id of the non-payroll administration. This field cannot simultaneously have a value with payrollAdministration (only one can have a value at a time) `nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the non payroll administration - `description` string: Description of the administration - `administration` Administration20240626, nullable: Id of the payroll administration. This field cannot simultaneously have a value with nonPayrollAdministration (only one can have a value at a time) `payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. - `id` string, uuid: The unique identifier of an object (GUID/UUID) - `name` string: Name of the payroll administration - `clientNumber` integer, nullable: The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling. - `description` string: Description of the administration - `administrationType` 'payrollAdministration' | 'nonPayrollAdministration': The type of administration - `typeOfEmployee` TypeOfEmployee: A selection of pre defined employee-types for the employment. NL: SoortWerknemer - `key` integer - `value` string - `employmentCategoryType` EmploymentCategoryType: A selection of special pre defined employment-types for the employment. NL: Type dienstverband - `key` integer - `value` string - `linkedEmployment` string, uuid, nullable: The unique identifier of an object (GUID/UUID) - `employmentDurationType` EmploymentDurationTypeVerion20191216: A selection of pre defined durations for the employment. NL: SoortDienstverband - `key` integer - `value` string - `startDateContractOfIndefiniteDuration` string, date, nullable: When did the value of `employmentDurationType` change for definite to indefinite. NL: Startdatum onbepaalde tijd This value should be te samen as the `startDate` if the contract was indefinite from the start. - `employmentContractType` EmploymentContractType, nullable: The type of employment applicable for the employment. NL: BasisDienstverband - `key` integer - `value` string - `vacationCoupons` VacationCoupons, nullable: Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s. NL: Vakantiebonnen - `key` integer - `value` string - `sendToExternalParty` SendToExternalParty, nullable: Indicates whether payroll information of this employment is sent to external pension funds. Attention: this indication ONLY applies regarding the information to pension funds. If NULL then setting according to regulation is leading. NL: AanleveringExternePartij - `key` integer - `value` string - `deviatingCLAExternalParty` integer, nullable: CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend - `deviatingCLATaxReturn` integer, nullable: CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV - `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. NL: NummerInkomstenVerhouding - `employeeProfileId` EmployeeProfileId, nullable: References to an employeeprofile that is specified in the payroll administration level. NL: WerknemerProfielID `employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. - `key` integer - `value` string - `professionCode` integer, nullable: A code field for a profession. This field only applies in case of a specific CLA (Bouw / Infra). Please leave empty if not applicable. NL: BeroepUWV - `exemptionWorkRelatedExpenseScheme` boolean: Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting - `exemptionPremiumWaiverMarginalLabour` boolean: Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid - `typeOfParticipation` TypeOfParticipation, nullable: The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension (product required). NL: AardDeelnemerschap - `key` integer - `value` string - `valueOfParticipation` ValueOfParticipation, nullable: The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension (product required). NL: WaardeDeelnemerschap - `key` integer - `value` string - `wachtgeldOldRegulation` boolean: Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling - `participation55plusRegulationUWV` boolean: Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus - `essMutationSet` EssMutationSet: References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations. Standard-set means the standard set defined for the administration will be applied for this employment. NULL means no set will be defined for this employment (so no access to any components). NL : ExportsetID `essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. - `key` integer - `value` string - `exemptionInsuranceObligation` ExemptionInsuranceObligation: Indicates whether an exemption applies for the insurance obligation. If NULL than there is no exemption, thus insurance obligation applies in that case (verzekingsplicht). NL: CodeUitzondering - `key` integer - `value` string - `specialIncomeRatio` SpecialIncomeRatio, nullable: Indicates the special income ratio. NL: SpecialeInkomstenVerhouding - `key` integer - `value` string - `emailLeaveRequest` string, nullable: Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag - `temporaryTaxExemption` TemporaryTaxExemption: Indicates whether there a temporary tax exemption is to be applied for the employment. NL: TijdelijkeHeffingskorting - `key` integer - `value` string - `periodPayGradeAdjustment` integer, nullable: The values is used for two processes. First off, a message can be configured to notify the user(s) of a upcoming wage raise/negotiation based on the value of this field. Second, the value, in combination with `signalSalaryScaleAdjustment`, is used to signal a wage raises based on the `payScale` and ‘payGrade’. NL: PeriodeSalarisPeriodiek - `signalPayGradeAdjustment` boolean: Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren - `commissionUntilDate1` string, date, nullable: Until date for commision #1. NL: AanstellingTot1 - `commissionUntilDate2` string, date, nullable: Until date for commision #2. NL: AanstellingTot2 - `commissionUntilDate3` string, date, nullable: Until date for commision #3. NL: AanstellingTot3 - `commissionUntilDate4` string, date, nullable: Until date for commision #4. NL: AanstellingTot4 - `commissionUntilDate5` string, date, nullable: Until date for commision #5. NL: AanstellingTot5 - `commissionUntilDate6` string, date, nullable: Until date for commision #6. NL: AanstellingTot6 - `isDirectorAndMajorShareholder` boolean, nullable: Indicates whether the employment can be classified as a director and major shareholder (Dutch: directeur-grootaandeelhouder or DGA). This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsDirecteurGrootAandeelhouder - `isPreviousOwner` boolean, nullable: Indicates whether the employment can be classified as a previous owner. This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsVorigeEigenaar - `isFamilyOfOwner` boolean, nullable: Indicates whether the employment can be classified as a previous owner. This field can be `null` in cases where it is unknown whether the employment can be classified as a director and major shareholder. NL: IsFamilieVanEigenaar - `isOnCallEmployment` boolean: Indicates whether the employment is an on-call employment. This field can be `null` in cases where it is unknown whether the employment is an on-call employment. NL: IsOproepkrachtOfInvalkracht - `hasOnCallAppearanceObligation` boolean, nullable: In the case of an on-call employment this field indicates whether the employment has an appearance obligation. This field can be `null` in cases where it is unknown whether the employment has an appearance obligation. NL: SoortOproepkrachtOfInvalkracht - `isGemoedsbezwaardNationalInsurance` boolean: Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering - `isGemoedsbezwaardEmployeeInsurance` boolean: Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering - `isAnonymousEmployee` boolean: An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer - `cancellationPeriodEmployee` integer, nullable: The notice period an employee is required to give the employer when resigning. The unit of time that applies to this field is described in the noticePeriodTimeUnit property. NL: OpzegtermijnWerknemer - `cancellationPeriodEmployer` integer, nullable: The notice period an employer is required to give the employee when terminating the contract. The unit of time that applies to this field is described in the noticePeriodTimeUnit property. NL: OpzegtermijnWerkgever - `cancellationPeriodTimeUnit` CancellationPeriodTimeUnit, nullable: The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties. NL: PeriodeOpzegTermijn - `key` integer - `value` string - `cancellationNoticeDate` string, date, nullable: The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging - `startCancellationNoticePeriod` string, date, nullable: The date on which the term of notice period starts. If the agrement states that a notice periode always starts on the first day of the month and the notice was given on the 15th the start notice periode will be the first day of the next month. NL: AanvangOpzegtermijn - `payrollId` integer: The payrolling number for this employment of the employee. Used by the payroll engine. This number is automatically generated and cannot be changed by the user. NL: PersoneelsnummerVerloning - `namePayslip` string, nullable: Name that is visible on payslips for the employment. NL: NaamLoonstrook - `calculateWorkingHours` boolean: Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren - `writtenEmploymentContract` boolean: Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst ## 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)