LOloket
Concept employee

Create a concept employee for an employer

Activity name : <a href="https://developer.loket.nl/Activities/PostConceptEmployeeByEmployerId" target="_blank">PostConceptEmployeeByEmployerId</a><br><br>Create a concept employee for an employer<br><br>* Possible options (metadata) for generic fields of the type \metadata" can be acquired (GET) by adding /metadata to the URL.<br>* Possible options dependent on a specific payrollAdministration can be acquired via ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}.<br>* Possible options for payGrade can be acquired via ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}.<br>A payGrade has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request to GET ../v2/providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}. This endpoint has the optional parameter "date" that may be used to specifying a measure date.<br><br>Defaults : Default values for a new object can be acquired by adding /defaults to the POST URL. <br><br> <br>Default values that are dependent on the selected payroll administration can be acquired by adding /v2/providers/employers/conceptemployees/defaults/payrolladministration/{payrollAdministrationId} to the POST URL.<br><br>NonPayrollAdministrations For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.<br>"

post/v2/providers/employers/{employerId}/conceptemployees

Request

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

Path parameters

employerIdstring uuid required

The unique identifier of the employer

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)

uniqueNamestring

The unique name for this concept employment. It is commonly used as a displayname in the user interface to select this entry in a dropdown box.

creationDatestring date-time

The date time on which the record was added (ISO-8601)

conceptEmployeeStatus'HasAccessToClient' | 'NoAccessToClient' | 'UserIsBlocked' | 'AccessToClientIsBlocked' | 'InvitePending' | 'InviteFailed' | 'InviteCancelled' | 'InviteExpired' | 'Done'

Description of the status

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "uniqueName": "Sollicitant 013",
  "creationDate": "2018-05-08",
  "employeeData": {
    "employeeNumber": 156,
    "personalDetails": {
      "firstName": "Susan",
      "lastName": "Bergen",
      "prefix": "van",
      "initials": "S.L.",
      "formattedName": "Wiel - van Bergen S.L. van de",
      "lastNamePartner": "Wiel",
      "prefixPartner": "van de",
      "dateOfBirth": "1995-05-21",
      "placeOfBirth": "Amsterdam",
      "howToFormatLastName": {
        "key": 2,
        "value": "last name + last name partner"
      },
      "title": {
        "key": 2,
        "value": "e.g. Msc, PHD or Baron"
      },
      "gender": {
        "key": 2,
        "value": "female"
      },
      "nationality": {
        "key": 2,
        "value": "Dutch"
      },
      "civilStatus": {
        "key": 2,
        "value": "Married"
      }
    },
    "contactInformation": {
      "phoneNumber": "+31 13-1234567",
      "mobilePhoneNumber": "+31 6-1231456",
      "faxNumber": "+31 13-1234561",
      "emailAddress": "info@loket.nl"
    },
    "identityDocument": {
      "typeOfDocument": {
        "key": 2,
        "value": "Passport"
      },
      "documentIdentification": "CRE45553433"
    },
    "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"
      }
    },
    "iban": "NL52ABNA0424968264"
  },
  "employmentData": {
    "startDate": "2019-01-01",
    "historicalStartDate": "2012-05-01",
    "payrollAdministration": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "name": "ABC accountants",
      "clientNumber": 1234,
      "description": "Bakker"
    },
    "nonPayrollAdministration": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "name": "ABC accountants",
      "description": "Bakker"
    },
    "commissionUntilDate": "2019-01-01",
    "incomeRelationshipNumber": 12,
    "employeeProfileId": {
      "key": 1,
      "value": "Profiel full-timers"
    },
    "employmentDurationType": {
      "key": 1,
      "value": "Contract of indefinite duration"
    },
    "startDateContractOfIndefiniteDuration": "2018-05-08",
    "employmentContractType": {
      "key": 1,
      "value": "Labor agreement"
    },
    "typeOfEmployee": {
      "key": 1,
      "value": "Werknemer"
    },
    "cancellationPeriodEmployee": 1,
    "cancellationPeriodEmployer": 1,
    "cancellationPeriodTimeUnit": {
      "key": 4,
      "value": "Maand(en)"
    },
    "cancellationNoticeDate": "2019-05-31",
    "startCancellationNoticePeriod": "2019-06-01",
    "isOnCallEmployment": true,
    "hasOnCallAppearanceObligation": true,
    "vacationCoupons": {
      "key": 1,
      "value": "n.v.t."
    },
    "specialIncomeRatio": {
      "value": "n.v.t."
    },
    "isAnonymousEmployee": true,
    "isGemoedsbezwaardNationalInsurance": true,
    "isGemoedsbezwaardEmployeeInsurance": true,
    "namePayslip": "Steve Jobs",
    "calculateWorkingHours": true,
    "essMutationSet": {
      "key": 1,
      "value": "Standaard"
    },
    "exemptionInsuranceObligation": {
      "value": "Geen uitzondering."
    },
    "sendMdvNotification": true,
    "periodPayGradeAdjustment": 2,
    "typeOfParticipation": {
      "value": "n.v.t."
    },
    "valueOfParticipation": {
      "value": "n.v.t."
    },
    "professionCode": 4,
    "deviatingCLATaxReturn": 2,
    "emailLeaveRequest": "api@loket.nl",
    "writtenEmploymentContract": true
  },
  "workingHoursData": {
    "shift": {
      "shiftNumber": 1,
      "fullTimeHoursPerWeek": 40,
      "bonusPercentage": 12
    },
    "deviatingHoursPerWeek": 32,
    "deviatingSvDaysPerPeriod": 32,
    "averageParttimeFactor": 37.5,
    "regularWorkPattern": true,
    "flexibleHoursContract": {
      "value": "n.v.t."
    },
    "contractCode": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 1022,
      "description": "SLA-PT-met toeslagen ATW (88)"
    },
    "calculateUsingWorkPattern": {
      "leaveHours": true
    },
    "workPattern": {
      "oddWeeks": {
        "monday": 8,
        "tuesday": 8,
        "wednesday": 4,
        "thursday": 7.5,
        "friday": 4
      },
      "evenWeeks": {
        "tuesday": 8,
        "wednesday": 8,
        "thursday": 8,
        "friday": 2
      }
    }
  },
  "wageData": {
    "grossWage": 23,
    "grossWageType": {
      "key": 2,
      "value": "hourly"
    },
    "netWageType": {
      "key": 1,
      "value": "hourly"
    },
    "payScale": {
      "key": 1,
      "value": "Glastuinbouw maand, Loongebouw A"
    },
    "payGrade": {
      "key": 1,
      "value": "Schaal B1, 15 jaar"
    },
    "applyPayGrade": true
  },
  "organizationalEntityData": {
    "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": "0133031600"
  },
  "socialSecurityData": {
    "healthCareInsuranceActType": {
      "key": 2,
      "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
    }
  },
  "fiscalData": {
    "annualSalary": 60000,
    "deviatingPayrollTaxTableColour": {
      "key": 2,
      "value": "Werknemer belastingpl. en niet premiepl. WLZ"
    },
    "deviatingPayrollTaxPercentage": 27.45,
    "applyDeviatingPayrollTaxPercentageOn": {
      "key": 2,
      "value": "Afwijkend voor tabel- en tariefloon"
    },
    "deviatingCalculationRulePayrollTax": {
      "key": 2,
      "value": "Werknemer belastingpl. en niet premiepl. WLZ"
    },
    "residentOf": {
      "key": 2,
      "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
    }
  },
  "otherPayrollVariablesData": {
    "deviatingPremiumGroup": {
      "key": 2,
      "value": "(12) Metaal- en technische bedrijfstakken"
    }
  },
  "selfService": {
    "clientName": "ESS"
  }
}

Response

Created

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",
    "uniqueName": "Sollicitant 013",
    "creationDate": "2018-05-08",
    "employeeData": {
      "employeeNumber": 156,
      "personalDetails": {
        "firstName": "Susan",
        "lastName": "Bergen",
        "prefix": "van",
        "initials": "S.L.",
        "formattedName": "Wiel - van Bergen S.L. van de",
        "lastNamePartner": "Wiel",
        "prefixPartner": "van de",
        "dateOfBirth": "1995-05-21",
        "placeOfBirth": "Amsterdam",
        "howToFormatLastName": {
          "key": 2,
          "value": "last name + last name partner"
        },
        "title": {
          "key": 2,
          "value": "e.g. Msc, PHD or Baron"
        },
        "gender": {
          "key": 2,
          "value": "female"
        },
        "nationality": {
          "key": 2,
          "value": "Dutch"
        },
        "civilStatus": {
          "key": 2,
          "value": "Married"
        }
      },
      "contactInformation": {
        "phoneNumber": "+31 13-1234567",
        "mobilePhoneNumber": "+31 6-1231456",
        "faxNumber": "+31 13-1234561",
        "emailAddress": "info@loket.nl"
      },
      "identityDocument": {
        "typeOfDocument": {
          "key": 2,
          "value": "Passport"
        },
        "documentIdentification": "CRE45553433"
      },
      "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"
        }
      },
      "iban": "NL52ABNA0424968264"
    },
    "employmentData": {
      "startDate": "2019-01-01",
      "historicalStartDate": "2012-05-01",
      "payrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "ABC accountants",
        "clientNumber": 1234,
        "description": "Bakker"
      },
      "nonPayrollAdministration": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "name": "ABC accountants",
        "description": "Bakker"
      },
      "commissionUntilDate": "2019-01-01",
      "incomeRelationshipNumber": 12,
      "employeeProfileId": {
        "key": 1,
        "value": "Profiel full-timers"
      },
      "employmentDurationType": {
        "key": 1,
        "value": "Contract of indefinite duration"
      },
      "startDateContractOfIndefiniteDuration": "2018-05-08",
      "employmentContractType": {
        "key": 1,
        "value": "Labor agreement"
      },
      "typeOfEmployee": {
        "key": 1,
        "value": "Werknemer"
      },
      "cancellationPeriodEmployee": 1,
      "cancellationPeriodEmployer": 1,
      "cancellationPeriodTimeUnit": {
        "key": 4,
        "value": "Maand(en)"
      },
      "cancellationNoticeDate": "2019-05-31",
      "startCancellationNoticePeriod": "2019-06-01",
      "isOnCallEmployment": true,
      "hasOnCallAppearanceObligation": true,
      "vacationCoupons": {
        "key": 1,
        "value": "n.v.t."
      },
      "specialIncomeRatio": {
        "value": "n.v.t."
      },
      "isAnonymousEmployee": true,
      "isGemoedsbezwaardNationalInsurance": true,
      "isGemoedsbezwaardEmployeeInsurance": true,
      "namePayslip": "Steve Jobs",
      "calculateWorkingHours": true,
      "essMutationSet": {
        "key": 1,
        "value": "Standaard"
      },
      "exemptionInsuranceObligation": {
        "value": "Geen uitzondering."
      },
      "sendMdvNotification": true,
      "periodPayGradeAdjustment": 2,
      "typeOfParticipation": {
        "value": "n.v.t."
      },
      "valueOfParticipation": {
        "value": "n.v.t."
      },
      "professionCode": 4,
      "deviatingCLATaxReturn": 2,
      "emailLeaveRequest": "api@loket.nl",
      "writtenEmploymentContract": true
    },
    "workingHoursData": {
      "shift": {
        "shiftNumber": 1,
        "fullTimeHoursPerWeek": 40,
        "bonusPercentage": 12
      },
      "deviatingHoursPerWeek": 32,
      "deviatingSvDaysPerPeriod": 32,
      "averageParttimeFactor": 37.5,
      "regularWorkPattern": true,
      "flexibleHoursContract": {
        "value": "n.v.t."
      },
      "contractCode": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "code": 1022,
        "description": "SLA-PT-met toeslagen ATW (88)"
      },
      "calculateUsingWorkPattern": {
        "leaveHours": true
      },
      "workPattern": {
        "oddWeeks": {
          "monday": 8,
          "tuesday": 8,
          "wednesday": 4,
          "thursday": 7.5,
          "friday": 4
        },
        "evenWeeks": {
          "tuesday": 8,
          "wednesday": 8,
          "thursday": 8,
          "friday": 2
        }
      }
    },
    "wageData": {
      "grossWage": 23,
      "grossWageType": {
        "key": 2,
        "value": "hourly"
      },
      "netWageType": {
        "key": 1,
        "value": "hourly"
      },
      "payScale": {
        "key": 1,
        "value": "Glastuinbouw maand, Loongebouw A"
      },
      "payGrade": {
        "key": 1,
        "value": "Schaal B1, 15 jaar"
      },
      "applyPayGrade": true
    },
    "organizationalEntityData": {
      "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": "0133031600"
    },
    "socialSecurityData": {
      "healthCareInsuranceActType": {
        "key": 2,
        "value": "(C/K) Wel verzekeringsplichtig, normaal tarief"
      }
    },
    "fiscalData": {
      "annualSalary": 60000,
      "deviatingPayrollTaxTableColour": {
        "key": 2,
        "value": "Werknemer belastingpl. en niet premiepl. WLZ"
      },
      "deviatingPayrollTaxPercentage": 27.45,
      "applyDeviatingPayrollTaxPercentageOn": {
        "key": 2,
        "value": "Afwijkend voor tabel- en tariefloon"
      },
      "deviatingCalculationRulePayrollTax": {
        "key": 2,
        "value": "Werknemer belastingpl. en niet premiepl. WLZ"
      },
      "residentOf": {
        "key": 2,
        "value": "Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden"
      }
    },
    "otherPayrollVariablesData": {
      "deviatingPremiumGroup": {
        "key": 2,
        "value": "(12) Metaal- en technische bedrijfstakken"
      }
    },
    "selfService": {
      "clientName": "ESS"
    }
  }
}

Changes

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