v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB

Placement

Create a placement for a worker, linked to an existing employment contract

Create a placement for a worker. Unlike /create-placement, this endpoint will not create an employment contract. The caller must provide an existing contractId to link the placement to.

post/public/placement/v1/create-placement-for-existing-contract

Request body

workerIdstring uuid required

The unique id of the worker, as returned from the /create-worker endpoint.

companyIdstring uuid required

The unique id of the client company.

employmentContractIdstring uuid required

The unique id of an existing employment contract to link this placement to. This endpoint will not create an employment contract.

departmentIdstring uuid

Optional. The unique id of the client company's department at which the worker will work. If not provided, the first department of the client company is used.

locationIdstring uuid required

The unique id of the client company's location at which the worker will work.

contactIdstring uuid required

The unique id of the client company's contact person (who will be mentioned in the contract).

shiftStartDateTimestring date-time required

The timestamp when the shift connected to the placement starts. Format: ISO 8601, must be in UTC. example: '2024-09-25T15:30:00Z'

shiftEndDateTimestring date-time required

The timestamp when the shift connected to the placement ends. Format: ISO 8601, must be in UTC. example: '2024-09-25T18:30:00Z'

collectiveLabourAgreementNumberinteger required

Number for this placement's collective labour agreement, as published by Centraal Bureau voor de Statistiek. Must be one of the collective labour agreements that are already registered for the given companyId

functionIdstring uuid required

The function applicable to the worker's activities for this placement. The id must be a value returned from the collective-labour-agreement API. Must be compatible with the collectiveLabourAgreementNumber.

functionTypestring

The function type applicable to the worker's activities for this placement. Must be a value returned from the collective-labour-agreement API. Must be compatible with the functionId.

functionLevelstring required

The function level applicable to the worker's activities for this placement. Must be a value returned from the collective-labour-agreement API. Must be compatible with the functionId.

educationstring

The education level applicable to the worker's activities for this placement. Must be a value returned from the collective-labour-agreement API. Must be compatible with the collectiveLabourAgreementNumber, functionType, functionLevel, and worker's age.

wageStepstring

The wage step applicable to the worker for this placement. Must be a value returned from the collective-labour-agreement API. Must be compatible with the collectiveLabourAgreementNumber, functionType, functionLevel, worker's age, education, and placement start date.

baseHourlyWagenumber required

The hourly wage the worker will earn for this placement, excluding surcharges, holiday allowance, etc. Must be compatible with the collective labour agreement-related properties, such as functionLevel, education, and wageStep.

Example request

{
  "baseHourlyWage": 18.21
}

Response

Successfully created the placement

workerDocumentIdstring uuid required

The unique id of the auto-signed placement contract document.

placementIdstring uuid required

The unique id of the placement.

startDatestring date required

The start date of the placement's contract.

endDatestring date required

The end date of the placement's contract. The contract runs up to and including this date.