LOloket
Employment

Edit the details of an employment

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

Edit the details of an employment

Possible values for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the URL

put/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

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

startDatestring date

The date on which this employment starts. NL: DatumInDienst

historicalStartDatestring 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

commissionUntilDatestring date nullable

The date on which the employment will end. NL: AanstellingTot

endDatestring date nullable

The date on which the employment ends. NL: DatumUitDienst

endOfEmploymentDueToIllnessboolean nullable

Indicates whether the reason for the termination of an employment is due to long-term illness. NL: ZiekUitDienst

firstDayNotificationboolean 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

linkedEmploymentstring uuid nullable

The unique identifier of an object (GUID/UUID)

startDateContractOfIndefiniteDurationstring 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.

deviatingCLAExternalPartyinteger nullable

CLA (CAO) code in case of a deviating CLA for external parties . NL: CaoKlantgroepAfwijkend

deviatingCLATaxReturninteger nullable

CLA (CAO) code in case of a deviating CLA for tax returns. NL: CAOUWV

incomeRelationshipNumberinteger

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

professionCodeinteger 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

exemptionWorkRelatedExpenseSchemeboolean

Indicates whether an exemption (i.e. non-participation) on the work-related expense scheme (werkkostenregeling) applies for this employment. NL: WerkkostenRegelingUitsluiting

exemptionPremiumWaiverMarginalLabourboolean

Indicates whether an exemption (i.e. waiver) on the premium marginal labour (vrijstelling marginale arbeid) applies for this employment. NL: PremieVrijstellingMarginaleArbeid

wachtgeldOldRegulationboolean

Indicates whether the (old) wachtgeld regulation is applicable for the employment. NL: WachtgeldOudeRegeling

participation55plusRegulationUWVboolean

Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment. NL: Deelname55Plus

emailLeaveRequeststring nullable

Recipient e-mail adress for notification in case of leave requests. NL: EmailVerlofaanvraag

periodPayGradeAdjustmentinteger 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

signalPayGradeAdjustmentboolean

Indicates whether signaling regarding salary scale adjustments are enabled for the employment. NL: SalarisschaalSignaleren

commissionUntilDate1string date nullable

Until date for commision #1. NL: AanstellingTot1

commissionUntilDate2string date nullable

Until date for commision #2. NL: AanstellingTot2

commissionUntilDate3string date nullable

Until date for commision #3. NL: AanstellingTot3

commissionUntilDate4string date nullable

Until date for commision #4. NL: AanstellingTot4

commissionUntilDate5string date nullable

Until date for commision #5. NL: AanstellingTot5

commissionUntilDate6string date nullable

Until date for commision #6. NL: AanstellingTot6

isDirectorAndMajorShareholderboolean 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

isPreviousOwnerboolean 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

isFamilyOfOwnerboolean 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

isOnCallEmploymentboolean

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

hasOnCallAppearanceObligationboolean 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

isGemoedsbezwaardNationalInsuranceboolean

Gemoedsbezwaard Volksverzekering. NL: IsGemoedsbezwaardVolksverzekering

isGemoedsbezwaardEmployeeInsuranceboolean

Gemoedsbezwaard Werknemerverzekering. NL: IsGemoedsbezwaardWerknemerverzekering

isAnonymousEmployeeboolean

An employee that wants to remain anonymous related to social security instances. NL: IsAnoniemeWerknemer

cancellationPeriodEmployeeinteger 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

cancellationPeriodEmployerinteger 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

cancellationNoticeDatestring date nullable

The date on which the notice was given by either the employee or the employer. NL: DatumOpzegging

startCancellationNoticePeriodstring 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

payrollIdinteger

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

namePayslipstring nullable

Name that is visible on payslips for the employment. NL: NaamLoonstrook

calculateWorkingHoursboolean

Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period. NL: Completeren/Berekenen uren

writtenEmploymentContractboolean

Did the employment and employer make a written contract? NL: Schriftelijke overeenkomst

Example request

{
  "employee": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "employeeNumber": 156,
    "firstName": "Susan",
    "initials": "S.L.",
    "prefix": "van",
    "lastName": "Bergen",
    "prefixPartner": "van de",
    "lastNamePartner": "Wiel",
    "formattedName": "Wiel - van Bergen S.L. van de",
    "dateOfBirth": "1995-05-21",
    "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}"
  },
  "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
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "employee": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "employeeNumber": 156,
      "firstName": "Susan",
      "initials": "S.L.",
      "prefix": "van",
      "lastName": "Bergen",
      "prefixPartner": "van de",
      "lastNamePartner": "Wiel",
      "formattedName": "Wiel - van Bergen S.L. van de",
      "dateOfBirth": "1995-05-21",
      "photo": "https://api.loket.nl/v2/v2/providers/employers/employees/{employeeId}/photo/{version}"
    },
    "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
  }
}

Changes

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