{"openapi":"3.0.2","servers":[{"description":"Production environment","url":"https://api.loket.nl/v2"},{"description":"Acceptance environment","url":"https://api.loket-acc.nl/v2"}],"x-hasEquivalentPaths":true,"info":{"description":"**Is this your first time here? Please check out our [introduction to Loket (API)](./Introduction)**\n\n**The initial loading time of this developer portal may be very long due to the large number of endpoints designs being rendered when loading the page.\nWe are looking into an alternative solution but for now please bear in mind.**\n\n\n# General\nThe Loket.nl API is a RESTful API that exposes the data and features of the Loket.nl platform.\nThe API accepts and returns JSON and can only be accessed by registered users.\nThis documentation describes version 2 of the API.\n\n\nAre you looking to partner up and start building an integration based on the Loket RESTful API? Please check out the steps for partners on our [website](https://www.loket.nl/koppelingen/koppelen-met-loket/) .\n\nHave you received your client and user credentials from us? Check out the following Postman collection to help you start making your first API calls on our acceptance environment. We would recommend to install the Postman desktop app.\n\n[](https://god.gw.postman.com/run-collection/19604713-42728000-2df3-4ff0-908e-dc6ab410990c?action=collection%2Ffork&collection-url=entityId%3D19604713-42728000-2df3-4ff0-908e-dc6ab410990c%26entityType%3Dcollection%26workspaceId%3Ddde2c409-9fb2-4f40-9981-f937f73750ea#?env%5BLoket.nl%20Test%20Environment%5D=W3sia2V5IjoiQXV0aGVudGljYXRpb25TZXJ2ZXJVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vb2F1dGgubG9rZXQtYWNjLm5sLyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJ0ZXh0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vYXV0aC5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6Ikxva2V0QXBpVXJsIiwidmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2FwaS5sb2tldC1hY2MubmwvIiwic2Vzc2lvbkluZGV4IjoxfSx7ImtleSI6IkNsaWVudF9JZCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiQ2xpZW50X1NlY3JldCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjN9LHsia2V5IjoiUmVkaXJlY3RfVXJpIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJyZWZyZXNoX3Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NX0seyJrZXkiOiJ0b2tlbiIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InRleHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjZ9XQ==)\n\n\nDo you want to contact us with any further questions or remarks regarding the Loket RESTful API? Please send an email to api@loket.nl, and we will get back to you.\n\n\n## Environments\nThe Loket.nl API has two different environments.\nThe first environment is the \"acceptance\" environment which is used during development and returns test data.\nThe second environment is the production environment which is to be used exclusively by approved applications.\nBoth environments have their own URLs.\n* The acceptance environment can be accessed at https://api.loket-acc.nl/v2/ \n* The production environment can be accessed at https://api.loket.nl/v2/\n\n## OpenAPI documentation\nThe endpoints are defined using the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification),\nan industry-wide recognized standard for describing REST API's.\n\n__Please note:__ the endpoint documentation in this portal is not designed to be fully compatible with any automatic code generation tools.\n\n## Change policy\nOver the course of time the API, and policies regarding the API can and will change. These changes are subject to the following guidelines.\n\n\nThe following states hold true for the change policy for this API.\n\n* Loket.nl may sometimes introduce changes to the API and policies without advance notice. \n* Loket.nl will try to inform users of any (breaking) change in advance.\n* Loket.nl will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.\n* Loket.nl will try to avoid breaking changes as much as possible.\n\n## Notification periods\nIn regard to changes Loket.nl will strive to adhere to the following notification periods per type of change.\nDue to our versioning strategy at resource level this API has the possibility to run multiple versions of the same resource at one time.\nThis allows for a window in which both the old and new version are available.\nAllowing for a gradual move to the new version. \n\n| Type of change | Notification period | Support period old version |\n|------------------|---------------|---------------|\n| Non breaking change | 2 weeks | no new version |\n| Breaking change | 2 weeks | 6 months |\n| Critical | Due to the nature of these changes we might not be able to follow the normal procedure for change managment | depends on the severity of the issue | \n\n\nWe define a __non breaking__ change as follows. Any change to the API that does not cause failures in the applications that consume that API.\n * Introducing a new optional field to an existing resource\n * Introducing a new endpoint\n * Introducing a new operation (GET/PUT/POST/PATCH/DELETE)\n * Introducing a new optional parameter to an endpoint\n * Introducing a new version for a resource\n\nWe define a __breaking change__ as follows. any change to an API that could potentially cause failures in the applications that consume that API.\n * Changing an existing JSON element (name, datatype, pattern, min/max length etc)\n * Removing a JSON element, endpoint, operation or parameter\n * Introducing a required JSON element\n * Introducing a required parameter to an endpoint\n * Passing the `obsoleteDate` of a version for a resource\n\n## Versioning\nThe Loket API uses two types of versioning. API versioning and resource versioning. \n\n\n__API versioning__\n\nAPI versioning is done via the path where after the domain URL (api.loket.nl) the path starts with the API version. The current version of the API is V2.\nThe API version is expected to change rarely as resource versioning is available to tackle most issues that need versioning.\n\n\n__Resource versioning__\n\nEvery __JSON__ resource in the API is versioned via the Accept header.\nAllowing users of the API to influence what version is returned by setting the __mandatory__ accept header.\nThe Accept header of request should have a value like `application/json;version=2018-01-01`. \nHere, the second part of the header is used to refer to a specific version of the resource (2018-01-01).\nWhen calling the API it is possible to supply other dates rather than the exact resources version(s). \nThe businesslogic will select the version that is ON or BEFORE the given date.\n\n\n__For example:__ let's say there are two versions of a resource.\nThese are 2018-01-01 and 2018-09-01. When calling the API you supply `application/json;version=2018-08-01`,\nin that case the API will use the version 2018-01-01 as its the nearest version in the past. \n\n\nA response returns what `resourceVersion` was used and the 'obsoleteDate' of that version (in most cases this is NULL).\nThe `obsoleteDate` indicates when the resources version will no longer be available via the API.\nWith the introduction of a new version of a resource the `obsoleteDate` for the old version will be set to 6 months after the introduction of the new resource. \nAllowing consumers of the resource 6 months to incorporate the change. Failure to do so will likely lead to failure in the implementation.\n\nIn this developer portal you can find the service contracts for each, active, version of a resource.\nIf, only if, there are multiple versions of a resource you can select the corresponding schema at that resource.\n\n## Changelog\nThe changelog for this API can be found [here](/Changelog).\n\nWe strongly advise every user ofthe Loket REST API the subscribe to the email feed. Please check out the link on the changelog page.\n\n\n## Legal notices\nYour use and access to the API is expressly conditioned on your compliance with the policies and restrictions related to the API. \nIf Loket.nl believes that you have or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked. \n\n# Authentication\nAuthorization in the Loket API is based on the industry-standard OAuth 2.0 protocol. For general information on OAuth 2.0 we kindly refer to the publicly-available documentation, https://oauth.net/2/ \n\n\nAn authorized user is required to call the Loket API.\n\n__Note:__ This is an SSL-only API.\n\n__Note:__ Only TLS 1.2 is supported.\n\n| Environment | TokenUrl | \n| -------------------- | -------------------------------- | \n| Acceptance | https://oauth.loket-acc.nl/token |\n| Production | https://oauth.loket.nl/token | \n\nThe following OAuth 2.0 flows are supported\n\n* Authorization Code flow (standard)\n* Refresh Token flow (extension on the Authorization Code Flow)\n* SSO flow (single sign-on)\n* Password flow\n\n## Authorization code flow\nFor most clients only the authorization_code (and thus refresh_token) will be supported. \nPassword grant type is not available for an external client.\n\nPlease click the link below to see documentation on implementing the authorization code flow by external clients.\n\n__[Documentation on implementing the OAuth 2.0 authorization code flow](./OauthCode)__\n\n## Refresh token flow\nAfter the authorization code flow yields a refresh token the refresh_token grant can be used to obtain an access/bearer token.\nThe expire time of the access/bearer is also returned in the response please take this into account.\nWith the refresh token flow the two factor step will be skipped.\n\n_Refresh token request example:_\n```\nPOST /token \ngrant_type=refresh_token&refresh_token={RefreshToken123}&client_Id={Client123}&client_secret={Secret123}\n```\n\n_Refresh token response example:_\n```json\n{\n \"access_token\": \"JESJDhMBy0NPTM9SiXmYAzW45clOiQ5wSyDq3VWluguGNoKym4WPSiJoTDx67TQ\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3599,\n \"refresh_token\": \"nGJtF6j6SeQbHAg\",\n \"two_factor_state\": \"None\"\n}\n```\n## SSO flow\nThe SSO (single sign-on) flow is based on OAuth 2.0 and requires the authorization flow to be completed.\n\n__For more information see:__ [Documentation on OAuth 2.0 SSO flow (for allowed clients)](./OauthSSO)\n\n\n__Please note:__ Among other things, it is possible to set up an SSO flow with both Loket en Werknemerloket.\n\n\n## Password flow\nThe password flow is typically NOT enabled for external clients. Only by exception will the password flow be enabled for security (and practical) reasons.\n\n_Password token request examples:_\n\n```\nPOST /token \ngrant_type=password&username={UserName123}&password={Password123}&client_Id={Client123}&client_secret={Secret123}\n```\nWhether client_secret is required is dependent on the configuration of the client.\n\n# Authorization\nIn this section we explain how the API authorization service determines if a request is authorized or not.\n\n## The authorization entities\n\n| Entity | Description |\n| ----|----|\n| Client | Loket.nl used the client as an additional authorisation entity. By linking clients to activities clients can only perform those activities they are linked to. |\n| User | Is linked to a client (by performing the authorization code flow) and to a set of rechten (configuration in loket.nl)|\n| Module (product) | Enables certain functionality for the provider/employer. Modules can be enabled and disabled on both provider and employer level.|\n| Role | Influences if certain \"rechten\" are available to the users with said role. It can also influence the scope of the data returned. For example: the API will deny an \"afdelings manager\" access to employee's that are not in the \"afdeling\" (department) that user is manager of|\n| Activity | Every action in the API has its own activity. Using the Open API 3.0 standard these activity names are incorporated in the documentation using the `operationId` and in most cases are named in the description of an endpoint.|\n| Rights (rechten) | Represent a group of activities.|\n\n## The authorization process\nThis flow assumes that both user and client are correctly configured and have access to the API. \n\n1. Does the client have access to the activity?\n2. Does the user have access to the activity (through \"recht\")?\n3. Does the role have access to the activity (through \"recht\")?\n4. Does the provider/employer have the required module enabled for the activity?\n5. Does the user have access to the specified entity/ID?\n\nIf the answer to all the questions above is yes then the request is authorized otherwise the request is denied with a HTTP status code 403 (Forbidden).\nSee the simplified authorization flow in the figure below.\n\n__Side note:__ users are linked to rechten and clients are linked to activities. This leaves room for discrepancies.\nWhere a client cannot perform the activity because the client is not authorized to call that activity even though the user does have the \"recht\" granting access to the activity.\n\n\n\n## Which users can use the API\nIn almost all use-cases a Loket user should meet the following requirements to successfully setup an integration with that user.\n\n* The user must be a normal Loket user (so NOT a webservice user)\n* The user must be active (not blocked)\n* The user must have access to an employer \n * For provider users this is done by assigning the user to the appropriate Team(s)\n * For employer users this is done by creating a user for or linking the user to the appropriate employer(s)\n* The user must have all appropriate rights\n * For provider users this is done by assigning appropriate rights via Team (or alternatively, directly to the user)\n * For employer users this is done by assigning appropriate rights to the user on employer level\n\n\nHow to setup an integration is described in the [Authentication](../#section/Authentication) section.\n\n\n__Side notes:__ \n* A user can have access to multiple employers with different rights per employer.\n* Please note that users set up to use the SOAP webservices (webservicegebruikers) are in no way suited to perform calls to the RESTful API, these require entirely different user set-ups.\n* User management on production is typically done by the provider (i.e. the accountant) and sometimes the employer. This is NOT something Loket.nl itself can do.\n\n# Data\n\n## Data types\nThe Loket.nl API accepts and returns JSON.\nComform the [OpenAPI 3.0 specification](https://github.com/OAI/OpenAPI-Specification) the following data types are supported:\n* string\n* number (point is used to separate the integer part from the fractional part of a number)\n* integer (from OpenAPI)\n* object\n* array\n* boolean\n\nFor most of these types, further specifications can be found in the `format` and `pattern` specifications in the service contract. \nFor example a `format: date` added to a string field indicates a valid date must be supplied.\n\n## Metadata\nFields of the type 'metadata' are fields for which the possible values can be acquired via the metadata endpoint of the resource.\n\nThe metedata can be obtained by appending /metadata to the current endpoint.\nUsing the GET verb the endpoint will return a JSON output with \"all\" the metadata for the given resource.\nIn some cases multiple requests are needed to obtain all the metadata required, an exmple is given below.\nTypically different metadata endpoints are availalbe for the POST and the PUT endpoint.\n\n\nIf metadata endpoints are avaible for a given endpoint/resource is mentioned in the description of that endpoint.\n\n### Example response\n```json\n{[\n {\n \"field\": \"gender\"\n options: [\n {\n \"key\": 1,\n \"value\":\"Man\"\n }\n {\n \"key\": 2,\n \"value\":\"Vrouw\"\n }\n ]\n },\n {\n \"field\": \"country\"\n options: [\n {\n \"isoCode\":\"NL\",\n \"key\": 530,\n \"value\":\"Nederland\"\n }\n {\n \"isoCode\":\"BE\",\n \"key\": 540,\n \"value\":\"België\"\n }\n ]\n }\n\n]}\n\n```\n\n\n### Example urls\n\n__Acquiring metadata for a POST Wage__\n```\n/v2/providers/employers/employees/employments/{employmentId}/wages/metadata\n```\n\n\n__Acquiring metadata for a PUT employee__\n```\n/v2/providers/employers/employees/{employeeId}/metadata\n```\n\n__Multiple requests to get all the metadata__\n\nIn some cases there are metadata fields dependant on the selected value off another metadata field.\nSuch is the case when adding a new concept employee. This is done in the employer context while several of the metadata fields are dependant on the payrollAdministration context.\n\n\n__For example:__\n\n__Request 1__, first of a normal metadata request is performed. The response for this request will contain a list of payrolladministration for the given employer.\n```\n/v2/providers/employers/b869ded6-0659-4d8d-9a8a-f9e22425ec9c/jobapplicant/metadata\n```\n\n__Request 2__, when a payrolladministration is selected perform a second request to acquire the payrolladministration specific metadata.\n```\n/v2/providers/employers/jobapplicant/metadata/payrolladministration/54369214-14a1-41ab-892a-ea8438e34d6f\n```\n\n__Request 3__, if a `payScale` is selected perform a third request to acquire the `payGrade` for that `payScale`.\n```\n/v2/providers/employers/jobapplicant/metadata/salaryScaleType/54369214-14a1-41ab-892a-ea8438e34d6f\n```\n\n### Types of metadata\nWe diferentiate between two types of metadata.\n\n1. Generic metadata field. The possible values for these fields are the same for every object no matter the provider, employer or employee etc. \nExamples are: country, gender and nationality.\n2. Context specific metadata field. Examples of contexts are employer, payroll administration, provider and Loket.nl.\nIn most cases the possible values for these field are resources in themselves and can be managed via the API. \nIf a metadata field is context specific the context is given in the description of the field. \nExamples are: function, department and leaveType.\n\n\n__Note:__ some context specific metadata field can have multiple contexts. \n\nFor example: it is possible to define an export set in the provider context. \nMaking that export set available for all payroll administrations linked to the provider. \nIt is also possible to add an export set in the payroll administration context. That export set is only available to that payroll administration.\nWhen requesting the metadata of export set the user will be presented with a combined list of the provider and payroll administration export sets.\n\n## Default values\nMany fields in the API have a default value. \nIn order to assist our API users to adhere to these defaults when creating a record (POST) we provide `/defaults` endpoints.\n\n* An object returned by the `defaults`endpoint resembles a fully expanded GET-object of that resource. The only case when a part of the object is NOT fully expanded is for a metaData-object that does not have a default value (for example '\"gender\":NULL'). \n * Whether an object within the resource is of the type metaData is indicated in the service contracts of that resource.\n* Context is determined by the GUID given in the Path. Examples are employer, payroll administration, employee and employment.\n* A scope is sometimes required to determine the defaults values. A scope could be a date by which Loket.nl can determine what default was active on that date. \n The scope can be set by supplying additional paraments in the request. If a scope is required but none is given the currently active or last know value is returned.\n* The fields with no default will be set to null (even if the field is normally non-nullable).\n* Because the GET-object is returned the readonly fields are also returned.\n\n\n\n__An example endpoint would be:__\n\n```\n/v2/providers/employers/employees/employments/{employmentId}/payrollperioddata/defaults\n```\n\n__resulting in the following output:__\n\n```json\n{\n \"payrollPeriod\": null,\n \"shift\": {\n \"shiftNumber\": 1\n },\n \"payslipType\": {\n \"key\": 2\n },\n \"payslipText\": null,\n \"distributionUnit\": {\n \"key\": \"b14acd0d-75d7-4fc8-8b22-4a3924585cab\"\n },\n \"costCenter\": {\n \"key\": 2\n },\n \"costUnit\": {\n \"key\": 2\n },\n \"payrollComponents\": []\n}\n```\n\n__Note: Defaults endpoints are not yet generically available. If a Defaults endpoint exists this will be explicitly stated at that specific resource.__\n\n## Date chains\nFor most of the resources with a startDate and endDate a chain is maintained. Chain meaning that no records can overlap in time.\nLoket.nl has two types of chains.\n\n\n1) __Broken chain:__ It is posible for gaps te exist between the records. It is also posible to add new records in between or before existing records aslong as no overlap occures.\n\n2) __Linked chain:__ No gaps between records are allowed. Its only posible to add new records to the end of the chain resulting in the closing of the reviouse record with the start date -1 as end date.\n\n__Note:__ Chains are sometimes maintained with an additional context. For example, For `benefits and deductions` the broken chain is maintained per `payrollComponent`. \nIt is possible to have multiple active records for different `payrollComponent` never two active records for the same `payrollComponent`. \n\n## Custom export\nFor some GET (list) endpoints the API supports exporting (part of) the output JSON as a XML/CSV file. This is done by setting the `X-ReportInput` and `Accept` header.\n\nThe `Accept` header supports the following 2 options:\n* CSV (text/csv;version=yyyy-MM-dd)\n* Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;version=yyyy-MM-dd)\n\n\nThe `X-ReportInput` is a custom header that requires a JSON object with the following structure as input.\n\nThe filename without extension for the report 'FileNameWithoutExtension'\ndelimiter --> The delimiter to be used. If not set \",\" is used\nArray of objects 'fields' with 2 fields:\n1. fieldName --> A Xpath reference to the field to be included in the export\n2. reportColumnName --> The column name for the field\n3. format --> Allows only for date formatting. e.g. dd-MM-yyyy for csv or dd-mm-yyyy for Excel (Excel only usses lowercase)\n 3.1 For CSV: see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings\n 3.2 For Excel: https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68\n\n__Example `X-ReportInput`:__\n```json\n{\n\"fileNameWithoutExtension\":\"MyExport\",\n\"delimiter\": \";\",\n\"fields\":\n [\n {\n \"fieldName\": \"startDate\",\n \"reportColumnName\": \"In dienst datum\",\n \"format\": \"dd-MM-yyyy\"\n },\n {\n \"fieldName\": \"personalDetails.firstName\",\n \"reportColumnName\": \"First Name\"\n },\n {\n \"fieldName\": \"personalDetails.lastName\",\n \"reportColumnName\": \"Last Name\"\n }\n ]\n}\n```\n__Example request:__\n```CURL\ncurl \n--location \n--request GET 'https://api.loket.nl/v2/providers/employers/155c8440-8ff6-4776-98db-5d2243a073e3/employees?orderby=employeeNumber' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: text/csv;version=2020-08-18' \\\n--header 'X-ReportInput: {\"FileNameWithoutExtension\":\"MyExport\",\"Fields\":[{\"fieldName\":\"personalDetails.initials\",\"reportColumnName\":\"Initials\"},{\"fieldName\":\"personalDetails.firstName\",\"reportColumnName\":\"First name\"},{\"fieldName\":\"personalDetails.lastName\",\"reportColumnName\":\"Last name\"}]}' \\--header 'Authorization: Bearer ZKoiC_g_NfYA3v0' \\\n```\n\n\n# Request\nA request to the Loket.nl API consists of several components.\nEach of these components are discussed in this section.\n\n## Base URL\nThe API can be accessed at [https://api.loket.nl](https://api.loket.nl).\n The version of the API is specified in the URL. The current version of the Loket.nl API is version 2. To access version 2 of the API, one simply appends `v2` to the base URL. The full base URL of the API is therefore [https://api.loket.nl/v2](https://api.loket.nl/v2).\n\n## Endpoints\nThe endpoints defined in the OpenAPI definition of the Loket.nl API are appended to the base URL. For example, the endpoint `/providers/employers/{employerId}/employees` can be accessed at [https://api.loket.nl/v2/providers/employers/{employerId}/employees](https://api.loket.nl/v2/providers/employers/{employerId}/employees).\n\n## Path parameters\n\nMost endpoints require path parameter(s) in order to specify the context of the request. For example, the endpoint `/providers/employers/{employerId}/employees` contains the `employerId` path parameter. A path parameter is a unique identifier that identifies a specific resource, in this case an employer.\n\n## Pagination\n\nThe API supports two query parameters to control the pagination of the results: `pageNumber` and `pageSize`. Both of these query parameters only apply to endpoints that return lists of entities.\n\nThe `pageNumber` query parameter specifies which page of the collection to return. By default `pageNumber` is set to 1 which returns the first page of the collection. Note: the pageNumber refers to the page (with a given number of entities), NOT to a specific entity within a page!\n\nThe `pageSize` query parameter influences the number of entities per page. By default `pageSize` is set to 250. Note that this default may change in the future. It is not recommended to depend on this default when developing for the Loket.nl API.\n\nExamples:\n\n* ```?pageNumber=2``` to return the second page\n* ```?pageSize=2``` to set the page size to two\n\n## Filtering\n\nThe API supports output filtering via the querystring parameter `filter`.\n\nFiltering is possible on all fields of the following datatypes:\n\n* string\n* integer\n* boolean\n* date-time\n* decimals\n\nThe following operators are available:\n\n| Operator | Description | Example |\n| -------------------- | --------------------- | ------------------------------- |\n| Comparison Operators | | |\n| eq | Equal | `city eq 'Redmond'` |\n| ne | Not equal | `city ne 'London'` |\n| lk | Like | `city lk 'Lond'` |\n| gt | Greater than | `price gt 20` |\n| ge | Greater than or equal | `price ge 10` |\n| lt | Less than | `price lt 20` |\n| le | Less than or equal | `price le 100` |\n| Logical Operators | | |\n| and | Logical and | `price le 200 and price gt 3.5` |\n| or | Logical or | `price le 3.5 or price gt 200` |\n\nBoth field names and values are case insensitive. It is possible to filter on nested fields by adding the parent object before the field with a '.' to separate them.\nDo remember to URL encode the filter parameters.\n\n### Examples\n\nAll employments with a cancellation periode in months (the value 4 corresponds to months time unit).\n\n```\n\n/v2/providers/employers/{{employerId}}/employees/employments?filter=cancellationPeriodTimeUnit.key eq 4\n\n```\n\nAll employments with no endDate.s\n\n```\n\n/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate eq null\n\n```\n\n\nAll employments with an end date less or equal to 2017-01-01\n\n```\n\n/v2/providers/employers/{{employerId}}/employees/employments?filter=enddate le '2017-01-01'\n\n```\n\nAll employees with a employee number greater or equal 1 and less or equal 5\n\n```\n\n/v2/providers/employers/{{employerId}}/employees?filter=employeeNumber ge 1 and employeeNumber le 5\n\n```\n\n## Ordering\n\nAll Loket.nl API resources support ordering of the elements in the response on a specific field. \nAll fields can be used in ordering. \nThe list can be ordered in ascending or descending order, with ascending being the default one. Ordering on multiple fields is also by using a ',' as a separator.\n\n### Examples\n\nOrder employers by company name ascending\n\n```\n\n/v2/providers/employers?orderBy=companyName\n\n```\n\nOrder employers by company name descending\n\n```\n\n/v2/providers/employers?orderBy=-companyName\n\n```\n\nOrder employers by company name descending then by house number ascending\n\n```\n\n/v2/providers/employers?orderBy=-companyName,address.houseNumber\n\n```\n\n## Headers\n\nIn order to access the endpoints of the Loket.nl API, at least two request headers need to be set. \n\n\n__1)__ the `Authorization` header is required in order to authorize the API call. \nThe value of this header is the word Bearer followed by a space and the access token acquired from the `/token` endpoint. \nFor example, if the acquired access token is `AbCdEf123456`, the value of the `Authorization` headers would be:\n\n```\nAuthorization: Bearer v69uloc3wcEFLePw2unot0FfAJfBocrvSwsrCo75JLUG7aE54zqSUnU\n```\n\n__2)__ The second header that is required for proper usage of the API, is the `Accept` header.\nThis header is used for the resource versioning feature and is therefore crucial for making sure the response remains the same when new resource versions are introduced.\nThe value of the `Accept` header differs per endpoint is defined in the OpenAPI documentation of the endpoints.\n\n```\nAccept: application/json;version=2018-01-01\n```\n\n# Response\n\nIn addition to the responses defined in the OpenAPI documentation, the Loket.nl API also provides additional fields that give more information about\nthe response and the entities requested. This section will explain the full response given by the Loket.nl API by examining the example response below.\n\n\nExample 400 response\n\n\n```json\n\n{\n \"version\": {\n \"obsoleteDate\": null,\n \"versionNumber\": \"2018-01-01,\n },\n \"messages\": [\n {\n \"code\": 83,\n \"id\": null,\n \"type\": \"BrokenBusinessRule\",\n \"description\": \"[field] has an invalid length\",\n \"properties\": []\n }\n ],\n \"_embedded\": []\n}\n\n```\n\n\nExample 200 response\n\n```json\n\n {\n \"totalSize\": 1,\n \"pageSize\": 250,\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"version\": {\n \"obsoleteDate\": null,\n \"resourceVersion\": \"2018-01-01\"\n },\n \"messages\": [],\n \"content\": {\n \"id\": \"2b4c119c-527c-4cbb-a5b2-f3a11e4b76cx\",\n ...\n }\n }\n\n```\n\n## Paging\n* `totalSize` has an integer value indicating the total number of entities irrespective of the page size.\n\n* `pageSize` has an integer value indicating the maximum number of entities returned per page. The page size can be influenced by setting the `pageSize` query parameter. See the section Query Parameters for more information.\n\n* `totalPages` has an integer value indicating the number of pages the requested collection holds given the specific pagesize.\n\n* `currentPage` has an integer value indicating the current page number. The current page number can be influenced by setting the `pageNumber` query parameter. See the section Query Parameters for more information.\n\n## Version\nThe `version` object provides information regarding the resource version of the entity requested.\n\n * `obsoleteDate` contains the date of discontinuation for the requested resource version. The value of this field can be `null` indicating that the requested resource version is not planned to be obsoleted at the time of the request.\n\n * `resourceVersion` shows the version of the requested entity. The resource version can be influenced by setting the `Accept` header.\n\n## Messages\nThe `messages` field contains a list of message objects related to the request made. Any warnings and errors will be communicated in this list of messages\n\n * `type` has a string value indicating the type of message. At this time the Loket.nl API supports five types of messages: `BrokenBusinessRule`, `Warning`, `Exception` and `NotFound` .\n \n * `description` has a string value that describes the message that has occurred.\n\n * `code` is an identifying code for the message. Please note that this code may change in the future. See the documentation portal for possible message codes for an endpoint.\n\n * `id` relates the message to a specific entity in the reponse list. For example, in cases where a warning occurs for one of the entities in a list, the value of this field can be used to identify to which entity the warning applies. Currently implemented for endpoints where a multi-patch is performed (multiple actions are performed within one call) for example updating the status of one or more leaveRequests. \n \n * `properties` an array that can contain additional information regarding the message. Currently not yet fully implemented.\n\n* `_embedded` contains the list of entities as defined for each endpoint in the OpenAPI documentation. Please refer to that documentation for the contents of the `_embedded` field for each endpoint. For endpoints that return only one entity (detail endpoints) the `_embedded` field is replaced with a `content` field. The content of this field can also be found in the documentation for each endpoint.\n\n## Headers\n* `Expires` header is returned with every response to indicate how long a response can be cached\n* `Content-Disposition` header is used in case of downloads to provide a file name\n\n## HTTP status codes\n\nThe Loket.nl API supports the following http status codes.\n\n| Code | Is returned when |\n|------------------|---------------|\n| 200 | The request to GET, PUT, PATCH or DELETE and object was recived and processed succesfully. The response might still contain messages of the type warning. |\n| 201 | The request to insert (POST) a new object was recived and processed succesfully. The response might still contain messages of the type warning.|\n| 400 | The request was received but could not be processed. The reason(s) will be given in the response. The content type of the response may be text/plain for API-level error messages, such as when trying to call the API without SSL otherwise the content will be application/json. |\n| 401 | The bearer token provided in the authorization header is invalid. Do not retry the request until a new (valid) bearer token is acquired. |\n| 403 | The user is not authorized to access the resource. The reason will be given in the response. Do not retry the request until the, configuration, issue is resolved. |\n| 404 | The resource requested was not found/does not exist. |\n| 50* | A unforseen error occurred. Please check the request if everything seems te be in order on your side contact the support team. Provide as much information as possible to resolve the issue. |\n\nNote: for a limited number of endpoint a so-called multi-patch may be performed (multiple actions within one call). In that case the status code will be 200 if at least on of the actions succeeds, if other any action(s) in that call fail(s) a message will be returned including the given id of that entity.\n\n## Caching\nThe API uses the `Expires` header to indicate how long the item can be reused from the local cache.\nIn most cases caching is not allowed for resources.\nExceptions excist, such as pictures like the employer logo and the employee photo, in these cases the cache duration is mentioned in the description of the resource.\n","title":"Loket.nl API","version":"V2","x-apisguru-categories":["enterprise"],"x-logo":{"url":"https://developer.loket-acc.nl/logo.png"},"x-origin":[{"format":"openapi","url":"https://developer.loket.nl/swagger.json","version":"3.0"}],"x-providerName":"loket.nl"},"tags":[{"description":"NL: Ziekmelding. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet').\n\nPlease note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket.nl . This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket.nl \n","name":"Absence"},{"description":"NL: Ziekteverloop. Absences due to either sickness/illness or absence due to, for example, maternity or organ donation (in Dutch 'vangnet'). One Absence contains one or more AbsenceProgress, indicating the degree of occupational disability over time of the absence.\n\nPlease note: when adding or updating an Absence or AbsenceProgress there will be no additional 'Melding' created in Loket.nl . This legacy mechanism in the older Loket GUI will NOT be included in the newer version of Loket.nl \n","name":"Absence Progress"},{"description":"NL: Contact historie. History of all contacts with the employee","name":"Contact history"},{"description":"NL: Verlof. Leave entries both addition and subtraction","name":"Leave"},{"description":"NL: Verlof aanvraag. Leave request for a certain type of leave. The types of leave can be managed at the employer level","name":"Leave request"},{"description":"NL: Verlof balans. Leave balances for all leave types known for the employment. The types of leave can be managed ath the employer level","name":"Leave balance"},{"description":"NL: Verlof regeling. Leave policies is used to set rules/ regulations for allocating leave numbers. Based on a leave policy leave can be generated automatically","name":"Leave policy"},{"description":"NL: Verlof regeling op providerniveau. Leave policies is used to set rules/ regulations for allocating leave numbers. Based on a leave policy leave can be generated automatically","name":"Provider leave policy"},{"description":"These endpoints allow the user to link leave policies and employments to one and other. If an employment is linked to leave policy, than the employment will get leave (verlofopbouw) based on the regulations when these are applied. The may a many-to-many relationship.","name":"Leave policy and employment links"},{"description":"These endpoints allow the user edit leave for multiple employments.","name":"Collective leave"},{"description":"NL: Administratie. Retrieve information about all administrations, both payroll administrations and non-payroll administrations.","name":"Administration"},{"description":"NL: Salarisverwerkende administratie. Manage a payroll administration. A Payroll administration is the link to the payrolling configuration","name":"Payroll administration"},{"description":"NL: Overzicht met de status -en mogelijke acties voor een periode.","name":"Payroll administration process overview"},{"description":"NL: Overzichten administratie. Download available reports on payroll administration level","name":"Payroll administration reports"},{"description":"NL: Exportset/componentset. Pre-defined sets of payroll components. Useful when working with large list of components","name":"Payroll component set"},{"description":"Calendar endpoints. Please note that filtering or ordering using the query string parameters may give somewhat unexpected results in some cases where an employment has been part of more than one department during the given period.","name":"Calendar"},{"description":"NL: Endpoints waarmee inzicht in de status van collective acties kan worden verkregen.","name":"Collective action"},{"description":"NL: Persoon. Manage an employee","name":"Employee"},{"description":"NL: Contactpersoon. Contact person of an employee","name":"Contact"},{"description":"NL: WAO/WIA. In case of occupational disabilities these can be manged here","name":"Occupational disability"},{"description":"Allows an employee the submit a change of address","name":"Change address request"},{"description":"Allows an employee the submit a change of contactinformation","name":"Change contactinformation request"},{"description":"NL: Werkgever. Manage an employer","name":"Employer"},{"description":"NL: Autorisaties (toegestane activities). Acquire the autorizations the user has for the given provider or employer","name":"Authorizations"},{"description":"NL: Concept Werknemer. Manage concept employees. In integrations with different applications it is sometimes necessary to use concept employee to create new employments within loket.nl. This is due to the fact that most systems don’t have all the fields required to create a new employment in loket.nl. Because for employee the validations are disabled. Allowing for the creation of a concept employee with only a subset of the fields that are required when creating a employment. At a later point the concept employee can be \"promoted\" to employee/employment using the Loket.nl interface. Please note that when a concept employee is promoted to an actual employee, the GUID of the employee will be identical to the concept employee from which it was created.","name":"Concept employee"},{"description":"NL: Signalen. Manage the notifications for a employer. Notifications are most commonly send by the system to inform the user of a certain event.","name":"Notification"},{"description":"NL: Mededelingen. Manage the announcements for a employer. Announcements are most commonly send by the system to inform the user changes in the CAO.","name":"Announcement"},{"description":"NL: Werkgever HR dashboard. Go to the Qlik employer dashboard","name":"Employer dashboard"},{"description":"Acquire a token to call the Data New Business (DNB) API","name":"Data New Business"},{"description":"NL: Functies. Manage the functions for the employer","name":"Functions"},{"description":"NL: Afdelingen. Manage the departments for the employer","name":"Departments"},{"description":"Manage the workflow triggers for the employer. Workflow triggers are triggers that trigger a workflow. With this resource you can manage which trigger will trigger what workflow.","name":"Workflow trigger mapping"},{"description":"NL: Eigen feestdagen. Manage the custom holidays for the employer.","name":"Custom holiday"},{"description":"NL: Nationale feestdagen. Manage the national holidays for the employer.","name":"National holiday"},{"description":"NL: Factureerbare items. Manage billable items for the employer","name":"Billable item"},{"description":"NL: Preboarding trajecten. ","name":"Preboarding trajectory"},{"description":"NL: Dienstverband. Manage an employment","name":"Employment"},{"description":"NL: Organisatorische Eenheid/ WerknemerFunctie. Manage the organizational entity for an employment, this includes but is not limited to department and function.
For Organizational Entity records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n","name":"Organizational entity"},{"description":"NL: Variabele gegevens. Payroll period data (e.g. hours worked or specific bonus) relates to a single payroll period.\n\nThere are also several other payroll related resources that work with start and end dates allowing these resources to span multiple payroll periods. We refer to those resources as payroll data, however THIS endpoint allows the user to determine only the value of specific payroll components for a specific payroll period (variabele gegevens, vs vaste gegevens). The payroll components that may be used as payroll period data (f.e. example component 1 relates to the normal hours worked in that period) are specific for the payroll administration to be used, even though there are some overall generic consistencies.","name":"Payroll period data"},{"description":"NL: Toeslagen. Payroll component data for part of, one or multiple payroll period(s). If the same `payrollComponent.Key` is also present in the `payroll period data` for a payroll period then, depending on the configuration in `payroll period data` the two values will either be 1) added up; or 2) payroll period data will overwrite the BenefitsAndDeduction for the given payroll period. Only certain payroll components are usable as a Benefit and Deduction, the corresponding categories are listed in payrollComponent.category in this resource.
Per payroll component a so called 'broken chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record. Also, if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record.\n","name":"Benefits and deductions"},{"description":"NL: Beloning. Manage the wage of an employment
For Wage records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n","name":"Wage"},{"description":"NL: Werktijd/ Arbeidstijd. Manage the working hours of an employment
For WorkingHours records, so called 'linked chain' business logic applies. This means that the records for that payroll component may NOT overlap each other, based on startDate and endDate of each record, AND because it is a linked chain is not allowed to have 'gaps' between separate records. This also means that if an existing record in the chain is not closed and a subsequent record is created than Loket will automatically set the endDate for the already existing record (and vice versa when deleting a record).\n","name":"Working hours"},{"description":"NL: Loonstroken/loonresultaten werknemer. Download the payslip(s) for an employment","name":"Payslip"},{"description":"NL: Jaaropgave. Download the year-end statement(s) for an employment","name":"Year-end statement"},{"description":"NL: Jaaropgave. Download the year-end statement(s) for the employments of a payroll administration","name":"Year-end statement at administration level"},{"description":"NL: Excasso (i.e. SEPA, IBAN). Manage the payment information. To what (SEPA country) IBAN is the wage/salary to be payed to. NOTEL by far the largest part of outgoing payments will be based on the information in these SEPA payment information records (i.e. this resource). Other resources may contain further payment specifics.","name":"Payment information"},{"description":"NL: Excasso afgesplitst van netto. This entity indicates, if applicable, the bank account(s) (i.e. IBAN's) where a given amount of the net salary for this employment will be paid to.\n \n\nNormally, the IBAN for the payment of net wage will be set by the PaymentInformation(SEPA) record. However, this entity allows to take a part of the net salary (a fixed amount) and set this to a different IBAN (for that part of the payment). For example, when a person wants to have part of his earnings to his regular banking account and part of his earnings to his savings account.\n","name":"Payment information separate payments"},{"description":"NL: Excasso Buitenland. Manage the payment information for non-SEPA payments. Mostly useful for performing foreign payments in case no SEPA/IBAN information is available.","name":"Payment information non-SEPA"},{"description":"NL: Fiscaal / Fiscale gegevens. Manage the fiscal property settings for an employment.","name":"Fiscal properties"},{"description":"NL: Werknemer auto fiscaal. Registration of company car for fiscal (tax-related) purposes","name":"Fiscal company car"},{"description":"NL: Werknemer auto. Registration of company car for HRM purposes","name":"Company car"},{"description":"NL: Diversen salarisverwerking. A collection of a divers set of payroll, wagetax and pension variables.","name":"Other payroll variables"},{"name":"RDW services"},{"description":"NL: Het opvragen van basis bedrijfsinformatie bij de kamer van koophandel.","name":"Chamber of commerce"},{"description":"NL: Fonds. The funds the employment partakes in","name":"Employment funds"},{"description":"NL: Abp Fonds. The abp funds the employment partakes in","name":"Abp funds"},{"description":"NL: FondsGrondslag. The base used in the calculation of the employment fund contribution","name":"Base for employment fund calculation"},{"description":"NL: Grondslag. The base used in certain calculation. Like the base amount to calculate leave allowance over","name":"Base for calculation"},{"description":"NL: Sociale verzekering. The configuration of these social security indications determines how these are handled in the payroll calculation processes for this employment.","name":"Social security"},{"description":"NL: Sociale uitkering. The configuration of these social security benefits determines how these are handled in the payroll calculation processes for this employment. This is a deviation from what is configured at payroll administration level.","name":"Social security benefits"},{"description":"NL: WerknemerZVW. The configuration of the Healthcare Insurance Act indications determines the calculation of the premiums in the payroll calculation processes for this employment","name":"Healthcare Insurance Act"},{"description":"NL: Loonbeslag. Attachment of earnings is a legal process in civil litigation by which a defendant's wages or other earnings are taken to pay for a debt.","name":"Attachment of earnings"},{"description":"NL: Beslagvrije voet. The protected earnings rate is agreed between the Court and the Employee and so will vary from order to order – it is not a predetermined amount. The Employees net take-home pay cannot be reduced by a attachment of earnings so that it is lower than this amount.","name":"Protected earnings"},{"description":"NL: Afwijkende AWF-premie. From 2020 it is possible that in exceptional cases a deviating AWF contribution (afwijkende AWF premie) has to be applied for an employment. If no exception is applicable please do not use this entity, in that case the payroll process will determine the applicable type of AWF contribution.","name":"Deviating AWF Contribution"},{"description":"NL: Transitievergoeding. Calculation help for determining tranistion compensation amount (transitievergoeding)","name":"Transition compensation"},{"description":"NL: Activeer profiel.","name":"Activate employee profile"},{"description":"NL: Pensioen uitkering. Pension benefit","name":"Pension benefit"},{"description":"NL: Huidige gegevens","name":"Actuals"},{"description":"NL: Achmea Verzuimverzekering. Manage the insurance contracts with Achmea","name":"Achmea"},{"description":"Get access to the Benify portal","name":"Benify"},{"description":"Functionality to enable the Qwoater -> Loket integration","name":"Qwoater"},{"description":"NL: Verloninsperiode. Payroll periods","name":"Payroll periodes"},{"description":"NL: Mutatieverslag. Allows the user to see the changes that were made over time","name":"Audit trail"},{"description":"NL: Loonresultaten. Payroll results","name":"Payroll results"},{"description":"NL: Verloningsrun/loonrun. Manage the payroll runs","name":"Payroll run"},{"description":"NL: Verloningsrun downloads. Download payroll runs related output (payslip, wage sheets etc)","name":"Payroll run downloads"},{"description":"NL: Loonresultaten per run. Acquire the data of the results of a payroll run","name":"Payroll run results"},{"description":"NL: Klaar met muteren.","name":"Period ready for payroll"},{"description":"NL: Provider (i.e. accountant) Provider related endpoints.","name":"Provider"},{"description":"NL: Autorisatie sets.","name":"Authorization sets"},{"description":"NL: Producten.","name":"Modules"},{"description":"NL: Journaalrun. Manage the journal runs","name":"Journal run"},{"description":"NL: Journaalrun resultaten. Acquire the data of the results of a journal run","name":"Journal run results"},{"description":"NL: Verdeling journaal. Manage of the allocation to different costCenters and costUnits for a given employment","name":"Journal allocation"},{"description":"NL: Journaal run overzicht. Journal run overview in csv format","name":"Journal run overview"},{"description":"NL: Browser variabele gegevens. Payroll period data on administration level. (Get periods via payroll periods within the payroll category)","name":"Payroll period data on administration level"},{"description":"NL: Loonaangifte. Manage the payroll tax returns","name":"Payroll tax return"},{"description":"NL: Loonaangifte downloads. Download tax return related output","name":"Payroll tax return downloads"},{"description":"NL: Loonaangifte response message. Payroll tax return response message","name":"Payroll tax return response message"},{"description":"NL: Loonaangifte obv berichtkenmerk. For some external parties it is more practical to perform these actions based on the messageReference as identifier.","name":"Payroll tax return by message reference"},{"description":"NL: Loonaangifte verwijderen. In exceptional cases the payroll tax return could be undone after it already has been approved","name":"Undo payroll tax return"},{"description":"Acquire address data","name":"Address"},{"description":"Manage children for an employee","name":"Child"},{"description":"Manage partners for an employee","name":"Partner"},{"description":"NL: Dienstverbandsjabloon. Templates (sjablonen) for creating a new employment","name":"Employment template"},{"description":"All workflow related endpoints","name":"Workflows"},{"description":"NL: Declaraties/werknemermutaties. Declarations can be created by the employee in Werknemerloket. After that the declarations will be subsequently reviewed and processed in the payrolling process. Please note that this ONLY includes the declarations via Werknemerloket, in general mutations are registered via payrollPeriodData","name":"Declarations"},{"description":"NL: Declaraties/werknemermutaties bijlagen. Declarations (werknemermutaties) may have an attachment linked to it. (via Qwoater dossier)","name":"Declarations attachments"},{"description":"NL: Initialiseer periode/ automatische processen activeren. One of the first steps in the payroll process is to initialise (automatische processen) for a given payroll period","name":"Initialise Payroll Period"},{"description":"NL: Start verloningsrun. This endpoint may be used to start running the actual process of a payroll run. (Verlonen)","name":"Initiate payroll run"},{"description":"NL: Verloningsrun goedkeuren/annuleren. After the payroll run has been succesfully processed (status 1) the results of the run may be either confirmed or cancelled.","name":"Review payroll run"},{"description":"NL: Verloningsrun verwijderen. In exceptional cases the payroll run could be undone after it already has been approved.","name":"Undo payroll run"},{"description":"Salarisschaalcel","name":"Paygrade"},{"description":"Employment dossier (werknemerdossier). Via Qwoater","name":"Employment dossier"},{"description":"Employer dossier (werkgeverdossier). Via Qwoater","name":"Employer dossier"},{"description":"Concept employee dossier (concept werknemerdossier). Via Qwoater","name":"Concept employee dossier"},{"description":"Administrative features related to document management.","name":"Document Management"},{"description":"Initiate an assessment. (External).","name":"Assessment"},{"description":"NL: Pensioenaangifte APG. Pension declation (pensioenaangiften) for APG .","name":"Apg pension declaration"},{"description":"NL: Pensioenaangifte UPA. Pension declation (pensioenaangiften) for UPA .","name":"Upa pension declaration"},{"description":"NL: Aangifte PAWW. Paww declation (aangifte PAWW) for PAWW .","name":"Paww declaration"},{"description":"NL: Werkgever Download Verzoek. An employer user may create a so-called download request. Once this request has been succesfully processed a download (zip file) will be available for this user, containing a wide set of data for the accessible employers. This data may be used for custom reporting or dashboarding etc. Please note this this function is only available for employer users (NOT provider users) and that the download file will contain information related to all employers this specific user has access to. Finally, only the user itself will have access to his/her own download requests.","name":"Download request"},{"description":"NL: KPU/ Kostprijs per uur. Indicates cost per hour for this employment","name":"Cost per hour"},{"description":"NL: Extra dienstverband. Create an additonal employment for an already existing Employee (tweede dienstverband)","name":"Create employment"},{"description":"NL: Afwijkend uurloon. Deviating hourly wage","name":"Deviating hourly wage"},{"description":"NL: Wachtgeld. Redundancy pay","name":"Wachtgeld"},{"description":"NL: Verstrekking. Benefit in kind","name":"Benefit in kind"},{"description":"NL: Eigen signaal. Custom notification","name":"Custom notification"},{"description":"NL: Opleiding. Education","name":"Education"},{"description":"The version number of an employer or employment may be used to decrease the number of calls in your sync-based integration.","name":"Last modified version numbers"},{"description":"NL: Dienstverband eigen veld. Employment custom field","name":"Employment custom field"},{"description":"NL: Persoon eigen veld. Employee custom field","name":"Employee custom field"},{"description":"NL: Eigen veld. Custom field","name":"Custom field"},{"description":"NL: Soort opleiding. Education type","name":"Education type"},{"description":"NL: Opleiding nadere aanduiding. Education further indication","name":"Education further indication"},{"description":"NL: Contractcode. Contract code","name":"Contract code"},{"description":"NL: Soort verstrekking. Benefit in kind type","name":"Benefit in kind type"},{"description":"NL: Document templates tbv documentgeneratie","name":"Document template"},{"description":"NL: Genereer een document op basis van een template","name":"Generate document"},{"description":"NL: Onderteken een document","name":"Sign document"},{"description":"NL: De Loketgebruiker. Loket user","name":"User"},{"description":"External tenants may be used to login to Loket.nl via Azure Active Directory","name":"External tenant"},{"description":"External tenants may be used to login to Loket.nl via Azure Active Directory. In order to do that a user must be configured in such a way that it is allowed to a certain external tenant to log in. This resource contains the link between an **employer** user and an allowed external tenant (for that user)","name":"External tenant employer user"},{"description":"External tenants may be used to login to Loket.nl via Azure Active Directory. In order to do that a user must be configured in such a way that it is allowed to a certain external tenant to log in. This resource contains the link between a **provider** user and an allowed external tenant (for that user)","name":"External tenant provider user"},{"description":"The filtersettings for the user to filter the employments.","name":"User filter settings"},{"description":"NL: Emailteksten.","name":"Email templates"},{"description":"NL: Voorgedefineerde sets met bijvoorbeeld producten, rechten en exportvelden.","name":"Applicationsets"},{"description":"NL: EmailIdenties die kunnen worden gebruikt als afzender bij het versturen van email.","name":"EmailIdentities"},{"description":"NL: Email Identies die kunnen worden gebruikt als afzender bij het versturen van email.","name":"Email Identities"},{"description":"Salarisvoorstel","name":"Wage proposal"}],"paths":{"/achmeainsurancecontracts":{"get":{"description":"__Activity name :__ GetAchmeaInsuranceContractsByUserId\nGet a list of all Achmea insurance contracts accessible to the current user\n","operationId":"GetAchmeaInsuranceContractsByUserId","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.808Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"belongsToEmployerId":{"description":"The unique identifier (a GUID/UUID) for the employer to which the Achmea isurance contract belongs. This id can be used for acquiring the list of employees for the employer.\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"contractNumber":{"description":"The contract number (Dutch: polisnummer) for the Achmea insurance contract.","example":"0015697843","maxLength":20,"nullable":false,"readOnly":true,"type":"string"},"endDate":{"description":"The date at which the Achmea isurance contract ends.","example":"2025-08-15T13:53:41.808Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"startDate":{"description":"The date at which the Achmea isurance contract starts.","example":"2025-08-15T13:53:41.808Z","format":"date","nullable":false,"readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.808Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"list of insurance contracts","tags":["Achmea"]}},"/achmeainsurancecontracts/{achmeaInsuranceContractId}/insuredwagecalculationpercentages":{"get":{"description":"__Activity name :__ GetWagePercentagesByAchmeaInsuranceContractId\n\nGet a list of all wage percentages (year-end bonus and holiday allowance percentages) for an Achmea insurance contract.\n","operationId":"GetWagePercentagesByAchmeaInsuranceContractId","parameters":[{"description":"The unique identifier of an Achmea insurance contract","in":"path","name":"achmeaInsuranceContractId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"endDate":{"description":"The last day on which the percentages apply to the wages of all employees included in the Achmea insurance contract. This field is empty when the percentages currently apply.","format":"date","nullable":true,"readOnly":false,"type":"string"},"holidayAllowancePercentage":{"description":"The percentage of the gross wage used to determine the holiday allowance.","example":8,"format":"double","nullable":true,"readOnly":false,"type":"number"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"startDate":{"description":"The first day on which the percentages apply to the wages of all employees included in the Achmea insurance contract.","example":"2025-08-15T13:53:41.809Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"yearEndPercentage":{"description":"The percentage of the gross wage used to determine the year-end bonus.","example":15,"format":"double","nullable":true,"readOnly":false,"type":"number"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"list of wage percentages for an insurance contract","tags":["Achmea"]}},"/aowDate":{"get":{"description":"__Activity name:__ GetAowDateByDateOfBirth\n\nThis endpoint allows the user to acquire the AOW date of an employee.\n","operationId":"GetAowDateByDateOfBirth","parameters":[{"description":"The date of birth of the employee","in":"query","name":"dateOfBirth","required":true,"schema":{"format":"date","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"nullable":true,"properties":{"aowDate":{"description":"The date when, according to Dutch law, the person has the right to a state pension. The value is generated by the system based on the date of birth.","example":"2025-08-15T13:53:41.809Z","format":"date","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Acquire the AOW date","tags":["AOW date"]}},"/applications/{applicationId}/authorizations":{"get":{"description":"__Activity name :__ GetApplicationAuthorizationsByApplicationId\n\nGet the authorizations of the application.\nWe expose which activities are accessable by the application and which \"rechten\" and \"producten\" are required for the user/employer to enable those activities.\n","operationId":"GetApplicationAuthorizationsByApplicationId","parameters":[{"description":"The unique identifier of an application","in":"path","name":"applicationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"activity":{"description":"name of the activity","example":"GetEmployersByUserId","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"allowedRoles":{"description":"Authorization is done based on a OR principle. The user has to have one of the listed roles the have access to the activity.","items":{"properties":{"description":{"description":"description of the role","example":"Provider","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"},"displayName":{"description":"description of the activity","example":"Lijst werkgevers","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"requiredEmployerModules":{"description":"Authorization is done based on a OR principle. The employer has to have one of the listed modules the have access to the activity.","items":{"properties":{"description":{"description":"description of the authorization (recht in loket)","example":"Personeelsregistratie","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"},"requiredUserAuthorizations":{"description":"Authorization is done based on a OR principle. The user has to have one of the listed authorizations the have access to the activity.","items":{"properties":{"availableForEmployerUser":{"description":"Indicates if the authorization is available for an employer user","example":true,"nullable":false,"readOnly":true,"type":"boolean"},"description":{"description":"description of the authorization (recht in loket)","example":"Beheren dienstverbanden","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Authorizations for the application","tags":["Application"]}},"/applications/{applicationId}/logo":{"get":{"description":"__Activity name :__ GetApplicationLogo\n\nThis activity is listed twice in the documentation due to the specified version caching path parameter. Including or exluding this parameter results in slightly different behaviour.\n\n__Caching:__ This resource changes very infrequently and can be cached for a longer time.\n\nGet the logo of the application. In case no logo is know the service will return a 404.","operationId":"GetApplicationLogo","parameters":[{"description":"The unique identifier of an application","in":"path","name":"applicationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"image/jpeg":{"schema":{"format":"binary","type":"string"}},"image/jpg":{"schema":{"format":"binary","type":"string"}},"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"OK"},"400":{"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Download the application logo","tags":["Application"]}},"/chamberofcommerce/{chamberOfCommerceNumber}/companyinformation":{"get":{"description":"__Activity name:__ GetCompanyInformationByChamberOfCommerceNumber\n\nThis endpoint allows the user to acquire basic company information for a specific chamber of commerce number.\n","operationId":"GetCompanyInformationByChamberOfCommerceNumber","parameters":[{"description":"The unique identifier of the kvk (8 numbers)","in":"path","name":"chamberOfCommerceNumber","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"nullable":true,"properties":{"address":{"nullable":false,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}},"type":"object"},"deviatingPostalAddress":{"nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Possible values can be aquired by the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address. Filled when poBox is empty.","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"poBox":{"description":"Post office box","example":5000,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"postalCode":{"description":"The postal code of the address, only nullable if country is not The Netherlands (NL).","example":"1234 AA","maxLength":9,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"legalForm":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the legal form. Possible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the legal form. Posible values are the legel forms supported by Dutch law","example":"B.V.","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"name":{"description":"The company name","example":"Bedrijf B.V.","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"sbi":{"description":"The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the SBI code. Possible values can be aquired via the metadata endpoint","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"sbiCode":{"description":"Posible values are the values from the Dutch SBI 2008","example":"0116","maxLength":32,"nullable":false,"readOnly":true,"type":"string"},"value":{"description":"Description of the SBI code","example":"Agriculture, Forestry and Fishing","maxLength":255,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"website":{"description":"The website of the employer","example":"www.voorbeeldbv.nl","format":"url","maxLength":255,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Acquire company information","tags":["Chamber of commerce"]}},"/datanewbusiness/functions":{"get":{"description":"__Activity name :__ GetDataNewBusinessFunctions
Get a list of functions known by Data New Business.
\n","operationId":"GetDataNewBusinessFunctions","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"functionName":{"description":"A function name in Dutch\n","example":"architect","nullable":false,"readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Get a list of functions","tags":["Data New Business"]}},"/datanewbusiness/token":{"get":{"description":"__Activity name :__ GetDataNewBusinessToken\n\nGet a token for calling the Data New Business (DNB) API. DNB is a part of Van Spaendonck and with its API, DNB provides users data-based insights such as the salary checker. \n","operationId":"GetDataNewBusinessToken","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"dataNewBusinessToken":{"description":"The access token for calling the Data New Business (DNB) API.","example":"tKcYuqJtbo7Q0wBzRzDFN6mnDghfJfvMOLMj0mOj9W1EW0wk9k8bWmRLug-AprELWHqHIc9f7Q6rNQQ6U6MNDGvVkxcnZH62FCebdqPhquBUEI1q24eCiqsT3Vn8eC27sX5phOhgHK9_bP2lLnDbqZoo5Li7bKmpS75S0_U7SO_BLyl6p-5jJHV2ZS0XFzjEkwIYkW3rPq41nDmbpuh1kNOyxa1fRbfmGhVJnGmWsQBxPwwypC30wFPUcNHHIBXlrryAXESR5Kal8gOolC5n09FlBFKW2EnCDyC-Wl2I0j95MZTUXwr-5JqiOQNWsILLE0GVW5EPmfvXo7hIRhpi1nl-XyWgHEl6wah9mW0G2sVXnbD0oBfMbFSBXTTcZpsVo3yTJB","format":"url","nullable":false,"readOnly":true,"type":"string"},"expiresIn":{"description":"The number of seconds until the token expires.","example":3600,"format":"int32","nullable":false,"readOnly":true,"type":"integer"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Get Data New Business token","tags":["Data New Business"]}},"/locationservices/address":{"get":{"description":"__Activity name :__ GetAddressyByPostalCodeAndHouseNumber
Acquire the address for a combination of `postalCode` and `houseNumber`. Only Dutch addresses are supported. Both the postalCode and houseNumber have to be specified as query parameters to perform a succesful call to this endpoint. The city and street name returned by this endpoint are according to the nen standard
\n","operationId":"GetAddressByPostalCodeAndHouseNumber","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"A valid postal code","example":"5037AA","in":"query","name":"postalCode","required":true,"schema":{"type":"string"}},{"description":"A valid house number (without addition)","example":1,"in":"query","name":"houseNumber","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"coordinates":{"nullable":true,"properties":{"latitude":{"description":"Lattitude of the location","example":51.62132245,"nullable":false,"readOnly":true,"type":"number"},"longitude":{"description":"Longitude of the location","example":5.55417593,"nullable":false,"readOnly":true,"type":"number"}},"readOnly":true,"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"postalCode":{"description":"The postal code of the address","example":"1234AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"province":{"description":"A Dutch province","format":"metadata","nullable":true,"properties":{"key":{"description":"The key for the province. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"value":{"description":"The name of the province. Only the Dutch provices are supported and not translated","example":"Noord-Holland","maxLength":50,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Acquire the address for a combination of `postalCode` and `houseNumber`","tags":["Address"]}},"/providers":{"get":{"description":"__Activity name :__ GetProvidersByUser\n\nGet a list of all providers accessible to the current user.\nNote: With the current functioning of Loket, the list will always contain 1 provider.\n\nNote: This endpoint is typically not relevant for most external parties, as the GetEmployerByUser endpoint will be much more relevant as starting point.\n","operationId":"GetProvidersByUser","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"name":{"description":"Name of the provider","example":"Van Spaendonck Online B.V.","maxLength":70,"nullable":false,"readOnly":false,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.809Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"List of providers","tags":["Provider"]}},"/providers/applicationsets/{applicationSetId}":{"delete":{"description":"__Activity name:__ DeleteProviderApplicationSetByApplicationSetId\n\nDelete an applicationset for the provider\n","operationId":"DeleteProviderApplicationSetByApplicationSetId","parameters":[{"description":"The unique identifier of the Applicationset","in":"path","name":"applicationSetId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a specific applicationset","tags":["Applicationsets"]},"put":{"description":"__Activity name:__ PutProviderApplicationSetByApplicationSetId\n\n\n Edit the details for an applicationset.\n","operationId":"PutProviderApplicationSetByApplicationSetId","parameters":[{"description":"The unique identifier of the Applicationset","in":"path","name":"applicationSetId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"nullable":true,"properties":{"applicationSetType":{"description":"The type of the set \n","enum":["Products","ExportDataTemplate","Rights"],"nullable":false,"readOnly":true,"type":"string"},"data":{"description":"Contains an array of objects in json structure.\n","example":"json object","nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"name":{"description":"Name of the exportset\n","example":"Exportset Dienstverband","maximum":50,"nullable":false,"readOnly":false,"type":"string"}},"type":"object"}}},"description":"Applicationset to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"nullable":true,"properties":{"applicationSetType":{"description":"The type of the set \n","enum":["Products","ExportDataTemplate","Rights"],"nullable":false,"readOnly":false,"type":"string"},"data":{"description":"Contains an array of objects in json structure.\n","example":"json object","nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"name":{"description":"Name of the exportset\n","example":"Exportset Dienstverband","maximum":50,"nullable":false,"readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of an applicationset","tags":["Applicationsets"]}},"/providers/authorizationsets/{authorizationsetid}":{"get":{"description":"__Activity name :__ GetAuthorizationSetsByAuthorizationSetId \n\n\n Details of an authorization set. \n","operationId":"GetAuthorizationSetsByAuthorizationSetId","parameters":[{"description":"The unique identifier of an authorization set","in":"query","name":"authorizationSetId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Automatically added","in":"path","name":"authorizationsetid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"authorizations":{"items":{"properties":{"availableForEmployerUser":{"example":true,"nullable":false,"readOnly":true,"type":"boolean"},"description":{"example":"Beheren dienstverbanden","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"readOnly":false,"type":"string"},"isEnabled":{"description":"Enable or disable an authorization","nullable":false,"readOnly":false,"type":"boolean"}}},"type":"array"},"description":{"example":"HR Gebruiker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a authorization set","tags":["Authorization sets"]}},"/providers/emailidentities/{emailIdentityId}":{"delete":{"description":"__Activity name:__ DeleteEmailIdentityByEmailIdentityId\n \n\nDelete an EmailIdentity for a provider. An EmailIdentity can only be deleted when it's not used in an emailTemplate.\n","operationId":"DeleteEmailIdentityByEmailIdentityId","parameters":[{"description":"The emailIdentity.","in":"path","name":"emailIdentityId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete an EmailIdentity for a provider","tags":["EmailIdentities"]}},"/providers/emailidentities/{emailIdentityId}/sendtestemail":{"post":{"description":"__Activity name:__ PostSendProviderTestemailByEmailIdentityId\n \n\nSend an email to test the email identity configuration. \n","operationId":"PostSendProviderTestemailByEmailIdentityId","parameters":[{"description":"The emailIdentity.","in":"path","name":"emailIdentityId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"nullable":true,"properties":{"to":{"description":"The emailadres to which a test email should be send.","example":"user@provider.com","nullable":false,"readOnly":false,"type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"description":"OK. The test email has been sent."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Provider emailIdentity test email","tags":["EmailIdentities"]}},"/providers/employers":{"get":{"description":"__Activity name :__ GetEmployersByUserId\n\nGet a list of all employers accessible to the current user\n\nPlease note the following general remark regarding the Loket API. If an id is required as a path parameter, in almost all cases the UUID of the specific resource should be used. In the employer resource this corresponds to the the 'id' field, as is typical. (so do NOT use employerNumber as your path parameter for any following requests)\n","operationId":"GetEmployersByUserId","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"allOf":[{"properties":{"address":{"nullable":false,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the further indication. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The description of the further indication, the posible values are \"WW\" and \"AB\"","example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address ","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"province":{"description":"A Dutch province","format":"metadata","nullable":true,"properties":{"key":{"description":"The key for the province. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"value":{"description":"The name of the province. Only the Dutch provices are supported and not translated","example":"Noord-Holland","maxLength":50,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}},"type":"object"},"branch":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the branch. Possible values can be aquired via the metadata endpoint","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the branch. Branch is only available in Dutch","example":"Landbouw en jacht","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"chamberOfCommerceNumber":{"description":"Chamber of commerce number. In Dutch \"Kamer van koophandel\" number","example":"18124676","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"companyName":{"description":"Name of the company","example":"Voorbeeld B.V.","maxLength":70,"nullable":false,"readOnly":false,"type":"string"},"contact":{"nullable":true,"properties":{"function":{"description":"The job title/function of the contact of the employer","example":"Manager","maxLength":50,"nullable":true,"readOnly":false,"type":"string"},"name":{"description":"Name of the contact of the employer","example":"Henk de Vries","maxLength":50,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The general phone number of the employer","example":"013-12345678","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"nullable":true,"properties":{"emailAddress":{"description":"The email address of the employer","example":"info@voorbeeldbv.nl","format":"email","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number of the employer","example":"(088) 31 11149","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The telephone number of the employer","example":"(088) 31 11150","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"website":{"description":"The website of the employer","example":"www.voorbeeldbv.nl","format":"url","maxLength":255,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"deviatingPostalAddress":{"nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Possible values can be aquired by the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the further indication. Possible values can be aquired by the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The description of the further indication, the posible values are \"WW\" and \"AB\"","example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address ","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"poBox":{"description":"Post office box","example":5000,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"postalCode":{"description":"The postal code of the address, only nullable if country is not The Netherlands (NL).","example":"1234 AA","maxLength":9,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"employerLogo":{"description":"The location of the logo of the employer. 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.","example":"https://api.loket.nl/v2/providers/employers/{guid}/logo/{version}","format":"url","nullable":true,"readOnly":true,"type":"string"},"employerNumber":{"description":"The employer number is used in various overviews and exports to identify a specific employer in Loket (please note: this is not the identifier used in the REST API).","example":20720,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"legalForm":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the legal form. Possible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the legal form. Posible values are the legel forms supported by Dutch law","example":"B.V.","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"providerLogo":{"description":"This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers)","example":"https://api.loket.nl/v2/providers/employers/{guid}/deviatingproviderlogo","format":"url","nullable":true,"readOnly":true,"type":"string"},"providerSettings":{"nullable":false,"properties":{"administrationNumber":{"description":"A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices.","example":"SR2","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"groupCode":{"description":"The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report).","example":40,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"parentEmployerForConsolidatedOverviews":{"description":"This field is used to link employers in order to generate reports containing the information of all the linked employers. By applying this method, infinite amount of employers can be linked.","example":9933,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"sendEmailWhenSalarySlipIsAvailable":{"description":"Indicates whether an e-mail should be sent to an employee if a salary slip becomes available in the employee portal (loket.nl's \"werknemer.loket\")","example":true,"nullable":false,"readOnly":false,"type":"boolean"}},"type":"object"},"sbi":{"description":"The 'Standard Industrial Classifications (Dutch SBI 2008, NACE and ISIC)' as defined bij the Dutch chamber of commerce","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the SBI code. Possible values can be aquired via the metadata endpoint","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"sbiCode":{"description":"Posible values are the values from the Dutch SBI 2008","example":"0116","maxLength":32,"nullable":false,"readOnly":true,"type":"string"},"value":{"description":"Description of the SBI code","example":"Agriculture, Forestry and Fishing","maxLength":255,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}]},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"List of employers","tags":["Employer"]}},"/providers/employers/announcements":{"patch":{"description":"__Activity name :__ PatchAnnouncementsByEmployerId\n\nMark announcements as read\n","operationId":"PatchAnnouncements","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"action":{"description":"The action to perform on the announcement","enum":["markAsRead"],"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"required":["id","action"],"type":"object"},"type":"array"}}},"description":"array of announcements to be changed","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.810Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Mark one or more announcements as read.","tags":["Announcement"]}},"/providers/employers/benefitinkindtypes/{benefitInKindTypeId}":{"delete":{"description":"__Activity name :__ DeleteBenefitInKindTypeByBenefitInKindTypeId\n\nDelete an existing benefit in kind type record\n","operationId":"DeleteBenefitInKindTypeByBenefitInKindTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"benefitInKindTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete an benefit in kind type record","tags":["Benefit in kind type"]},"get":{"description":"__Activity name :__ GetBenefitInKindTypeByBenefitInKindTypeId\n\nGet the details of an benefit in kind type\n","operationId":"GetBenefitInKindTypeByBenefitInKindTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"benefitInKindTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"description":{"description":"The description of the benifit in kind type","example":"Laptop","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of an benefit in kind type","tags":["Benefit in kind type"]},"put":{"description":"__Activity name :__ PutBenefitInKindTypeByBenefitInKindTypeId\n","operationId":"PutBenefitInKindTypeByBenefitInKindTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"benefitInKindTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"description":{"description":"The description of the benifit in kind type","example":"Laptop","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"description":{"description":"The description of the benifit in kind type","example":"Laptop","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit an benefit in kind type record","tags":["Benefit in kind type"]}},"/providers/employers/collectiveactions/{collectiveActionId}":{"get":{"description":"__Activity name :__ GetCollectiveActionMessagesByCollectiveActionId\n\nGet the messages of all collectiveActionItems of a single collective action\n","operationId":"GetCollectiveActionMessagesByCollectiveActionId","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"The unique identifier of the collective action","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","in":"path","name":"collectiveActionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"description":"List of all items in the collective action.","properties":{"collectiveActionItemId":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"collectiveActionType":{"description":"the type of collectiveAction","enum":["Werknemerloket","Beloning","etc."],"nullable":false,"readOnly":true,"type":"string"},"createdOn":{"description":"Date-time when the collectiveActionItem was created.","example":"2025-08-15T13:53:41.811Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"},"entityType":{"description":"The unique identifier of the entity to which the item applies \n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"messages":{"description":"array of messages of an collectiveactionitem.","items":{"nullable":false,"properties":{"code":{"description":"Identifying code for the message","example":266,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"description":"Describes the message","example":"Startdate is greater than Enddate.","nullable":false,"readOnly":true,"type":"string"},"type":{"description":"Indication of the type of message. Possible values are: 0\tBrokenBusinessRule 1\tException 2\tConcurrencyViolation 3\tNotFound 4\tWarning 5\tUnauthorized 6\tInfo","nullable":false,"properties":{"key":{"example":0,"nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"BrokenBusinessRule","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"nullable":true,"type":"array"},"succes":{"description":"status of the collectiveActionItem","example":true,"nullable":false,"readOnly":true,"type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"List of messages of a collective action","tags":["Collective action"]}},"/providers/employers/conceptemployees/import/{payrollAdministrationId}":{"patch":{"description":"__Activity name :__ PatchImportConceptEmployeesByPayrollAdministrationId\n\n__Metadata:__ No metadata\n\nCurrently supported file is the payroll tax return XML (year 2022 or later).\n","operationId":"PatchImportConceptEmployeesByPayrollAdministrationId","parameters":[{"description":"The unique identifier of the concept employee","in":"query","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Automatically added","in":"path","name":"payrollAdministrationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","type":"string"}}},"description":"Document to be uploaded for the concept employee.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"failed":{"items":{"properties":{"employeeNumber":{"description":"The employee number to uniquely identify an employee within an employer\n","example":156,"format":"int32","minimum":1,"nullable":true,"readOnly":true,"type":"integer"},"formattedName":{"description":"preformatted user name for displaying. \\\\\", \\\"\\\\\" \\\"\\","example":"Jong, I","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"index":{"description":"The location of the employee in the import file. The index start with 1 for the first employment in the file\n","example":2,"format":"int32","minimum":1,"nullable":false,"readOnly":true,"type":"integer"}},"type":"object"},"type":"array"},"successfull":{"items":{"properties":{"employeeNumber":{"description":"The employee number to uniquely identify an employee within an employer\n","example":156,"format":"int32","minimum":1,"nullable":true,"readOnly":true,"type":"integer"},"formattedName":{"description":"preformatted user name for displaying. \\\\\", \\\"\\\\\" \\\"\\","example":"Jong, I","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"index":{"description":"The location of the employee in the import file. The index start with 1 for the first employment in the file\n","example":2,"format":"int32","minimum":1,"nullable":false,"readOnly":true,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"413":{"description":"The request is larger than the server is willing or able to process."},"415":{"description":"The server refuses to accept the request because the payload format is in an unsupported format."},"500":{"description":"Internal Server Error"}},"summary":"Import concept employees via a file","tags":["Import"]}},"/providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}/payScale/{payscaleKey}/paygrade/{paygradeKey}":{"get":{"description":"__Activity name :__ GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey\n\nAcquire data on a specific paygrade, this consists of a list of paygrade values and their respective startDates.\n\nIf a valid `date` parameter is included in the call, the list will consists of one item that is applicable for that date.\n","operationId":"GetConceptEmployeePayGradeMetaDataByPayrollAdministrationIdAndPayscaleKeyAndPayGradeKey","parameters":[{"description":"The unique identifier of an administration","in":"path","name":"payrollAdministrationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Key for specific payscale","in":"path","name":"payscaleKey","required":true,"schema":{"type":"integer"}},{"description":"Key for specific paygrade","in":"path","name":"paygradeKey","required":true,"schema":{"type":"integer"}},{"description":"A valid date (xxxx-xx-xx)","in":"query","name":"date","required":false,"schema":{"format":"date","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"items":{"items":{"properties":{"startDate":{"description":"Start date of the record.\n","example":"2025-08-15T13:53:41.811Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"value":{"description":"Resulting amount for given paygrade","example":1153.1,"format":"double","type":"number"}},"type":"object"},"type":"array"},"type":"array"}}},"description":"OK"}},"summary":"Paygrade metadata for concept employee","tags":["Paygrade"]}},"/providers/employers/conceptemployees/minimized/{conceptEmployeeId}":{"get":{"description":"__Activity name :__ GetConceptEmployeeMinimizedByConceptEmployeeId\n\n\n Get the details of a concept employee with fewer fields\n","operationId":"GetConceptEmployeeMinimizedByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.811Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a concept employee with fewer fields.","tags":["Concept employee"]},"put":{"description":"__Activity name :__ PutConceptEmployeeMinimizedByConceptEmployeeId\n\nEdit the details of a concept employee with fewer fields.\n\n* Possible options (metadata) for generic fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the URL.\n","operationId":"PutConceptEmployeeMinizedByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.811Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"Concept employee to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.811Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.812Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.812Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of a concept employee with fewer fields.","tags":["Concept employee"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}":{"delete":{"description":"__Activity name :__ DeleteConceptEmployeeByConceptEmployeeId\n\nDelete a concept employee\n","operationId":"DeleteConceptEmployeeByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"If true, all underlying documents will be deleted.","example":false,"in":"query","name":"deleteDocuments","required":false,"schema":{"type":"boolean"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.812Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.812Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a concept employee","tags":["Concept employee"]},"get":{"description":"__Activity name :__ GetConceptEmployeeByConceptEmployeeId\n\n\n Get the details of a concept employee\n","operationId":"GetConceptEmployeeByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.812Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"creationDate":{"description":"The date time on which the record was added (ISO-8601)","example":"2025-08-15T13:53:41.812Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"},"employeeData":{"nullable":false,"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"deviatingPostalAddress":{"description":"The deviating address of the employee (used as a postal address)","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"employeeNumber":{"description":"The employee number to uniquely identify an employee within an employer.","example":156,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"identityDocument":{"description":"The identification document of the employee","nullable":true,"properties":{"documentIdentification":{"description":"Description of the type of document","example":"CRE45553433","maxLength":20,"nullable":true,"readOnly":false,"type":"string"},"typeOfDocument":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key for the type of document. Possible values can be acquired via the metadata endpoint","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Passport","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentData":{"nullable":true,"properties":{"calculateWorkingHours":{"description":"Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"cancellationNoticeDate":{"description":"The date on which the notice was given by either the employee or the employer.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"cancellationPeriodEmployee":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodEmployer":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodTimeUnit":{"description":"The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties.","format":"metadata","nullable":true,"properties":{"key":{"example":4,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Maand(en)","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"commissionUntilDate":{"description":"The date on which the employment will end.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"deviatingCLATaxReturn":{"description":"CLA (CAO) code in case of a deviating CLA for tax returns .","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"employeeProfileId":{"description":"References to an employeeprofile that is specified in the payroll administration level\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Profiel full-timers","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentContractType":{"description":"The type of employment applicable for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Labor agreement","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentDurationType":{"description":"A selection of pre defined durations for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Contract of indefinite duration","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"essMutationSet":{"description":"References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Standaard","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"exemptionInsuranceObligation":{"description":"Indicates whether an exemption applies for the insurance obligation. If NULL than there is no exemption, thus insurance obligation applies in that case (verzekingsplicht)","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Geen uitzondering.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"firstDayNotification":{"description":"Indicates whether first-day notification (EersteDagsMelding) is applicable for the employment","example":false,"nullable":true,"readOnly":true,"type":"boolean"},"hasOnCallAppearanceObligation":{"description":"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.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"historicalStartDate":{"description":"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.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"incomeRelationshipNumber":{"description":"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.","example":12,"format":"int32","maximum":9999,"nullable":true,"readOnly":false,"type":"integer"},"isAnonymousEmployee":{"description":"Indicates whether employee is anonymous ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isDirectorAndMajorShareholder":{"description":"Indicates whether the employment can be classiefied 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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isFamilyOfOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardEmployeeInsurance":{"description":"Gemoedsbezwaard Werknemerverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardNationalInsurance":{"description":"Gemoedsbezwaard Volksverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isOnCallEmployment":{"description":"Indicates whether the employment is an on-call employment.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isPreviousOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"namePayslip":{"description":"Name that is visible on payslips for the employment","example":"Steve Jobs","maxLength":34,"nullable":true,"readOnly":false,"type":"string"},"nonPayrollAdministration":{"description":"An administration that can not be used for payrolling. This field can not have a value at the same time as `payrollAdministration`\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"participation55plusRegulationUWV":{"description":"Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"payrollAdministration":{"description":"An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"clientNumber":{"description":"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.","example":1234,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"periodPayGradeAdjustment":{"description":"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’.","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"professionCode":{"description":"A code field for a profession.","example":4,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"sendMdvNotification":{"description":"Indicate if a Mdv (melding dienstverband) should be send.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"signalPayGradeAdjustment":{"description":"Indicates whether signaling regarding salary scale adjustments are enabled for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"specialIncomeRatio":{"description":"Indicates the special income ratio","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"startCancellationNoticePeriod":{"description":"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.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDate":{"description":"The date on which this employment starts.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDateContractOfIndefiniteDuration":{"description":"When did the value of `employmentDurationType` change for definite to indefinite. This value should be te samen as the `startDate` if the contract was indefinite from the start.","example":"2025-08-15T13:53:41.812Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"typeOfEmployee":{"description":"A selection of pre defined employee-types for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"typeOfParticipation":{"description":"The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"vacationCoupons":{"description":"Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"valueOfParticipation":{"description":"The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"writtenEmploymentContract":{"description":"Dit the employment and employer make a written contract?","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"fiscalData":{"nullable":true,"properties":{"annualSalary":{"description":"The fiscal annual salary","example":60000,"format":"double","maximum":1000000000,"minimum":0,"nullable":true,"readOnly":false,"type":"number"},"applyDayTables":{"description":"Indicates whether the value of the day table is used for the calculation of payroll tax","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyDeviatingPayrollTaxPercentageOn":{"description":"Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable","format":"metadata","nullable":false,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Afwijkend voor tabel- en tariefloon","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"applyPayrollTaxDeduction":{"description":"Indicates whether payroll tax deduction is appliclable (loonheffingskorting)","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyStudentDeduction":{"description":"Apply the \"Scholierenregeling\"","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingCalculationRulePayrollTax":{"description":"Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"deviatingPayrollTaxPercentage":{"description":"Indicates a deviating payroll tax percentage is to be applied","example":27.45,"format":"double","nullable":true,"readOnly":true,"type":"number"},"deviatingPayrollTaxTableColour":{"description":"Indicates if there is a deviating payroll tax table is applicable (green vs white table)","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"residentOf":{"description":"Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden","maxLength":80,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"organizationalEntityData":{"nullable":true,"properties":{"department":{"description":"The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingFunctionDescription":{"description":"The deviating function description of the employment. This description deviates from the value of the `function` field.","example":"Directeur","nullable":true,"readOnly":false,"type":"string"},"deviatingFunctionGroup":{"description":"The deviating functiongroup description of the employment.","example":"9A","nullable":true,"readOnly":false,"type":"string"},"distributionUnit":{"description":"Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center. \n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. \n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Sales","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"function":{"description":"The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"example":"Directeur","nullable":false,"readOnly":true,"type":"string"},"group":{"example":"internal","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"internalTelephoneExtensionNumber":{"description":"The phone extention number for the employment.","example":"0133031600","nullable":true,"readOnly":false,"type":"string"},"placeOfEmployment":{"description":"The place of employment (standplaats) for the employment.","example":"Amsterdam office","nullable":true,"readOnly":false,"type":"string"},"standardFunction":{"description":"The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"category":{"example":1,"format":"int32","nullable":true,"readOnly":true,"type":"integer"},"code":{"example":"A21","maxLength":6,"minLength":1,"nullable":true,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Administrateur","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"otherPayrollVariablesData":{"nullable":true,"properties":{"deviatingPremiumGroup":{"description":"Indicates what deviating premie sector fonds should apply for the employment. Do not specify if there is no deviation from the premium group for the payroll administration the employment is linked to.","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(12) Metaal- en technische bedrijfstakken","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"selfService":{"properties":{"status":{"description":"Description of the status","enum":["HasAccessToClient","NoAccessToClient","UserIsBlocked","AccessToClientIsBlocked"],"maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"socialSecurityData":{"nullable":true,"properties":{"healthCareInsuranceActType":{"description":"Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(C/K) Wel verzekeringsplichtig, normaal tarief","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"isInsuredForOccupationalDisabilityInsuranceAct":{"description":"Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForSicknessBenefitsAct":{"description":"Will contributions for the Sickness Benefits Act (ZW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForUnemploymentInsuranceAct":{"description":"Will contributions for the Unemployment Insurance Act (WW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"uniqueName":{"description":"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.","example":"Sollicitant 013","maxLength":255,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"wageData":{"nullable":true,"properties":{"applyPayGrade":{"description":"Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. \n","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"grossWage":{"description":"The gross wage for the employee\n","example":23,"format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"grossWageType":{"description":"Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"netWage":{"description":"Net wage for the employment\n","format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"netWageType":{"description":"Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payGrade":{"description":"The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Schaal B1, 15 jaar","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payScale":{"description":"A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Glastuinbouw maand, Loongebouw A","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"workingHoursData":{"nullable":true,"properties":{"averageParttimeFactor":{"description":"This field is used to register the deviating value of the parttimefactor. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100","example":37.5,"format":"double","maximum":999.99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"calculateUsingWorkPattern":{"description":"Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).","nullable":false,"properties":{"daysDailyRate":{"description":"Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingDaysAndHours":{"description":"Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)!","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursBrokenPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"leaveHours":{"description":"Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"contractCode":{"description":"This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":1022,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"SLA-PT-met toeslagen ATW (88)","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingHoursPerWeek":{"description":"Fulltime hours are normally based as defined by the shift, this optional field is used to register a deviating value. The value can be less or more then the fulltime hours a week.","example":32,"format":"double","maximum":99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"deviatingSvDaysPerPeriod":{"description":"Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. ","example":32,"maximum":23,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"flexibleHoursContract":{"description":"The field indicates the type of flexible contract. If not applicable, please set to NULL.","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"regularWorkPattern":{"description":"When the employee works the same amount of hours per day every week, then the workpattern is regular. ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"shift":{"description":"The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"bonusPercentage":{"description":"The bonus percentage used in wage calculations for the hours made in this shift. ","example":12,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"fullTimeHoursPerWeek":{"description":"The full time hours for an employment that is linked to this shift.","example":40,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"shiftNumber":{"description":"The number for the shift. ","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"}},"type":"object"},"workPattern":{"description":"The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n","nullable":true,"properties":{"evenWeeks":{"properties":{"friday":{"example":2,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":8,"format":"double","maximum":24,"minimum":0,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"},"oddWeeks":{"properties":{"friday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":7.5,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.813Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a concept employee","tags":["Concept employee"]},"put":{"description":"__Activity name :__ PutConceptEmployeeByConceptEmployeeId\n\nEdit the details of a concept employee\n\n* Possible options (metadata) for generic fields of the type \"metadata\" can be acquired (GET) by adding `/metadata` to the URL.\n* Possible options dependent on a specific payrollAdministration can be acquired via `../providers/employers/conceptemployees/metadata/payrollAdministration/{payrollAdministrationId}`.\n* Possible options for payGrade can be acquired via `../providers/employers/conceptemployees/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}`.\n\nA `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request `../providers/employers/conceptemployees/metadata/payscale/{payScaleKey}/paygrade/{payGradeKey}`.\n\n\n__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent MetaData-endpoints are also available as described above. However NO specific defaults endpoint is available for the nonPayrollAdministration.\n","operationId":"PutConceptEmployeeByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"creationDate":{"description":"The date time on which the record was added (ISO-8601)","example":"2025-08-15T13:53:41.813Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"},"employeeData":{"nullable":false,"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"deviatingPostalAddress":{"description":"The deviating address of the employee (used as a postal address)","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"employeeNumber":{"description":"The employee number to uniquely identify an employee within an employer.","example":156,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"identityDocument":{"description":"The identification document of the employee","nullable":true,"properties":{"documentIdentification":{"description":"Description of the type of document","example":"CRE45553433","maxLength":20,"nullable":true,"readOnly":false,"type":"string"},"typeOfDocument":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key for the type of document. Possible values can be acquired via the metadata endpoint","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Passport","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentData":{"nullable":true,"properties":{"calculateWorkingHours":{"description":"Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"cancellationNoticeDate":{"description":"The date on which the notice was given by either the employee or the employer.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"cancellationPeriodEmployee":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodEmployer":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodTimeUnit":{"description":"The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties.","format":"metadata","nullable":true,"properties":{"key":{"example":4,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Maand(en)","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"commissionUntilDate":{"description":"The date on which the employment will end.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"deviatingCLATaxReturn":{"description":"CLA (CAO) code in case of a deviating CLA for tax returns .","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"employeeProfileId":{"description":"References to an employeeprofile that is specified in the payroll administration level\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Profiel full-timers","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentContractType":{"description":"The type of employment applicable for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Labor agreement","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentDurationType":{"description":"A selection of pre defined durations for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Contract of indefinite duration","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"essMutationSet":{"description":"References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Standaard","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"exemptionInsuranceObligation":{"description":"Indicates whether an exemption applies for the insurance obligation. If NULL than there is no exemption, thus insurance obligation applies in that case (verzekingsplicht)","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Geen uitzondering.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"firstDayNotification":{"description":"Indicates whether first-day notification (EersteDagsMelding) is applicable for the employment","example":false,"nullable":true,"readOnly":true,"type":"boolean"},"hasOnCallAppearanceObligation":{"description":"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.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"historicalStartDate":{"description":"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.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"incomeRelationshipNumber":{"description":"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.","example":12,"format":"int32","maximum":9999,"nullable":true,"readOnly":false,"type":"integer"},"isAnonymousEmployee":{"description":"Indicates whether employee is anonymous ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isDirectorAndMajorShareholder":{"description":"Indicates whether the employment can be classiefied 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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isFamilyOfOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardEmployeeInsurance":{"description":"Gemoedsbezwaard Werknemerverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardNationalInsurance":{"description":"Gemoedsbezwaard Volksverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isOnCallEmployment":{"description":"Indicates whether the employment is an on-call employment.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isPreviousOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"namePayslip":{"description":"Name that is visible on payslips for the employment","example":"Steve Jobs","maxLength":34,"nullable":true,"readOnly":false,"type":"string"},"nonPayrollAdministration":{"description":"An administration that can not be used for payrolling. This field can not have a value at the same time as `payrollAdministration`\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"participation55plusRegulationUWV":{"description":"Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"payrollAdministration":{"description":"An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"clientNumber":{"description":"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.","example":1234,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"periodPayGradeAdjustment":{"description":"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’.","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"professionCode":{"description":"A code field for a profession.","example":4,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"sendMdvNotification":{"description":"Indicate if a Mdv (melding dienstverband) should be send.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"signalPayGradeAdjustment":{"description":"Indicates whether signaling regarding salary scale adjustments are enabled for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"specialIncomeRatio":{"description":"Indicates the special income ratio","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"startCancellationNoticePeriod":{"description":"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.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDate":{"description":"The date on which this employment starts.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDateContractOfIndefiniteDuration":{"description":"When did the value of `employmentDurationType` change for definite to indefinite. This value should be te samen as the `startDate` if the contract was indefinite from the start.","example":"2025-08-15T13:53:41.813Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"typeOfEmployee":{"description":"A selection of pre defined employee-types for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"typeOfParticipation":{"description":"The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"vacationCoupons":{"description":"Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"valueOfParticipation":{"description":"The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"writtenEmploymentContract":{"description":"Dit the employment and employer make a written contract?","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"fiscalData":{"nullable":true,"properties":{"annualSalary":{"description":"The fiscal annual salary","example":60000,"format":"double","maximum":1000000000,"minimum":0,"nullable":true,"readOnly":false,"type":"number"},"applyDayTables":{"description":"Indicates whether the value of the day table is used for the calculation of payroll tax","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyDeviatingPayrollTaxPercentageOn":{"description":"Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable","format":"metadata","nullable":false,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Afwijkend voor tabel- en tariefloon","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"applyPayrollTaxDeduction":{"description":"Indicates whether payroll tax deduction is appliclable (loonheffingskorting)","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyStudentDeduction":{"description":"Apply the \"Scholierenregeling\"","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingCalculationRulePayrollTax":{"description":"Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"deviatingPayrollTaxPercentage":{"description":"Indicates a deviating payroll tax percentage is to be applied","example":27.45,"format":"double","nullable":true,"readOnly":true,"type":"number"},"deviatingPayrollTaxTableColour":{"description":"Indicates if there is a deviating payroll tax table is applicable (green vs white table)","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"residentOf":{"description":"Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden","maxLength":80,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"organizationalEntityData":{"nullable":true,"properties":{"department":{"description":"The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingFunctionDescription":{"description":"The deviating function description of the employment. This description deviates from the value of the `function` field.","example":"Directeur","nullable":true,"readOnly":false,"type":"string"},"deviatingFunctionGroup":{"description":"The deviating functiongroup description of the employment.","example":"9A","nullable":true,"readOnly":false,"type":"string"},"distributionUnit":{"description":"Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center. \n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. \n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Sales","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"function":{"description":"The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"example":"Directeur","nullable":false,"readOnly":true,"type":"string"},"group":{"example":"internal","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"internalTelephoneExtensionNumber":{"description":"The phone extention number for the employment.","example":"0133031600","nullable":true,"readOnly":false,"type":"string"},"placeOfEmployment":{"description":"The place of employment (standplaats) for the employment.","example":"Amsterdam office","nullable":true,"readOnly":false,"type":"string"},"standardFunction":{"description":"The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"category":{"example":1,"format":"int32","nullable":true,"readOnly":true,"type":"integer"},"code":{"example":"A21","maxLength":6,"minLength":1,"nullable":true,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Administrateur","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"otherPayrollVariablesData":{"nullable":true,"properties":{"deviatingPremiumGroup":{"description":"Indicates what deviating premie sector fonds should apply for the employment. Do not specify if there is no deviation from the premium group for the payroll administration the employment is linked to.","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(12) Metaal- en technische bedrijfstakken","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"selfService":{"properties":{"status":{"description":"Description of the status","enum":["HasAccessToClient","NoAccessToClient","UserIsBlocked","AccessToClientIsBlocked"],"maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"socialSecurityData":{"nullable":true,"properties":{"healthCareInsuranceActType":{"description":"Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(C/K) Wel verzekeringsplichtig, normaal tarief","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"isInsuredForOccupationalDisabilityInsuranceAct":{"description":"Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForSicknessBenefitsAct":{"description":"Will contributions for the Sickness Benefits Act (ZW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForUnemploymentInsuranceAct":{"description":"Will contributions for the Unemployment Insurance Act (WW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"uniqueName":{"description":"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.","example":"Sollicitant 013","maxLength":255,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"wageData":{"nullable":true,"properties":{"applyPayGrade":{"description":"Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. \n","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"grossWage":{"description":"The gross wage for the employee\n","example":23,"format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"grossWageType":{"description":"Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"netWage":{"description":"Net wage for the employment\n","format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"netWageType":{"description":"Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payGrade":{"description":"The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Schaal B1, 15 jaar","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payScale":{"description":"A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Glastuinbouw maand, Loongebouw A","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"workingHoursData":{"nullable":true,"properties":{"averageParttimeFactor":{"description":"This field is used to register the deviating value of the parttimefactor. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100","example":37.5,"format":"double","maximum":999.99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"calculateUsingWorkPattern":{"description":"Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).","nullable":false,"properties":{"daysDailyRate":{"description":"Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingDaysAndHours":{"description":"Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)!","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursBrokenPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"leaveHours":{"description":"Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"contractCode":{"description":"This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":1022,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"SLA-PT-met toeslagen ATW (88)","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingHoursPerWeek":{"description":"Fulltime hours are normally based as defined by the shift, this optional field is used to register a deviating value. The value can be less or more then the fulltime hours a week.","example":32,"format":"double","maximum":99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"deviatingSvDaysPerPeriod":{"description":"Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. ","example":32,"maximum":23,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"flexibleHoursContract":{"description":"The field indicates the type of flexible contract. If not applicable, please set to NULL.","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"regularWorkPattern":{"description":"When the employee works the same amount of hours per day every week, then the workpattern is regular. ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"shift":{"description":"The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"bonusPercentage":{"description":"The bonus percentage used in wage calculations for the hours made in this shift. ","example":12,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"fullTimeHoursPerWeek":{"description":"The full time hours for an employment that is linked to this shift.","example":40,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"shiftNumber":{"description":"The number for the shift. ","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"}},"type":"object"},"workPattern":{"description":"The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n","nullable":true,"properties":{"evenWeeks":{"properties":{"friday":{"example":2,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":8,"format":"double","maximum":24,"minimum":0,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"},"oddWeeks":{"properties":{"friday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":7.5,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"Concept employee to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.813Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"creationDate":{"description":"The date time on which the record was added (ISO-8601)","example":"2025-08-15T13:53:41.813Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"},"employeeData":{"nullable":false,"properties":{"address":{"description":"The address of the employee","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"contactInformation":{"description":"Contact information for the employee","nullable":true,"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"faxNumber":{"description":"The fax number to contact this individual","example":"+31 13-1234561","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the employee.","example":"+31 6-1231456","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"deviatingPostalAddress":{"description":"The deviating address of the employee (used as a postal address)","nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"country":{"description":"The country of residence of the employee","format":"metadata","nullable":true,"properties":{"isoCode":{"example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"furtherIndication":{"description":"Futher indication of the address for example onboard (a ship) or living in a trailer","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"location":{"description":"The location like to further specify the address","example":"Fourth floor or building C","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":true,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"employeeNumber":{"description":"The employee number to uniquely identify an employee within an employer.","example":156,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"iban":{"description":"International Bank Account Number. Only IBAN without spaces are accepted.","example":"NL52ABNA0424968264","maxLength":35,"nullable":true,"readOnly":false,"type":"string"},"identityDocument":{"description":"The identification document of the employee","nullable":true,"properties":{"documentIdentification":{"description":"Description of the type of document","example":"CRE45553433","maxLength":20,"nullable":true,"readOnly":false,"type":"string"},"typeOfDocument":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key for the type of document. Possible values can be acquired via the metadata endpoint","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Passport","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"personalDetails":{"description":"The personal details of the employee. e.g. Name, civil status en gender","nullable":false,"properties":{"civilStatus":{"description":"The civil status of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Married","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"dateOfBirth":{"description":"The date of birth of the employee.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"firstName":{"description":"The first name of the employee.","example":"Susan","maxLength":28,"nullable":true,"readOnly":false,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":true,"readOnly":true,"type":"string"},"gender":{"description":"The gender of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"female","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"howToFormatLastName":{"description":"Indicates how the system will format `formattedName`. ","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"last name + last name partner","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"initials":{"description":"The initials of the employee.","example":"S.L.","maxLength":6,"nullable":true,"readOnly":false,"type":"string"},"lastName":{"description":"The last name of the employee.","example":"Bergen","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"lastNamePartner":{"description":"The last name of the employee`s partner.","example":"Wiel","maxLength":25,"nullable":true,"readOnly":false,"type":"string"},"nationality":{"description":"The nationality of the employee","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Dutch","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"placeOfBirth":{"description":"Place of birth of the employee","example":"Amsterdam","maxLength":24,"nullable":true,"readOnly":false,"type":"string"},"prefix":{"description":"The prefix to the last name of the employee.","example":"van","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"prefixPartner":{"description":"The prefix to the last name of the employee\"s partner.","example":"van de","maxLength":10,"nullable":true,"readOnly":false,"type":"string"},"title":{"description":"The title to be used (if any).","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"e.g. Msc, PHD or Baron","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"employmentData":{"nullable":true,"properties":{"calculateWorkingHours":{"description":"Automatically calculate working hours for the employment if the option automatically calculate hours is selected for a given period.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"cancellationNoticeDate":{"description":"The date on which the notice was given by either the employee or the employer.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"cancellationPeriodEmployee":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodEmployer":{"description":"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.","example":1,"format":"int32","maximum":1000,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"cancellationPeriodTimeUnit":{"description":"The unit of time used for the noticePeriodeEmployee and noticePeriodEmployer properties.","format":"metadata","nullable":true,"properties":{"key":{"example":4,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Maand(en)","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"commissionUntilDate":{"description":"The date on which the employment will end.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"deviatingCLATaxReturn":{"description":"CLA (CAO) code in case of a deviating CLA for tax returns .","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"employeeProfileId":{"description":"References to an employeeprofile that is specified in the payroll administration level\n\n`employeeProfileId` is a metadata field within the payroll administration context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Profiel full-timers","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentContractType":{"description":"The type of employment applicable for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Labor agreement","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"employmentDurationType":{"description":"A selection of pre defined durations for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Contract of indefinite duration","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"essMutationSet":{"description":"References to a specified set of payrollcomponents that are to accessible via ESS for employee mutations\n\n`essMutationSet` is a metadata field within the werkgever/provider context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Standaard","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"exemptionInsuranceObligation":{"description":"Indicates whether an exemption applies for the insurance obligation. If NULL than there is no exemption, thus insurance obligation applies in that case (verzekingsplicht)","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Geen uitzondering.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"firstDayNotification":{"description":"Indicates whether first-day notification (EersteDagsMelding) is applicable for the employment","example":false,"nullable":true,"readOnly":true,"type":"boolean"},"hasOnCallAppearanceObligation":{"description":"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.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"historicalStartDate":{"description":"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.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"incomeRelationshipNumber":{"description":"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.","example":12,"format":"int32","maximum":9999,"nullable":true,"readOnly":false,"type":"integer"},"isAnonymousEmployee":{"description":"Indicates whether employee is anonymous ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isDirectorAndMajorShareholder":{"description":"Indicates whether the employment can be classiefied 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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isFamilyOfOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardEmployeeInsurance":{"description":"Gemoedsbezwaard Werknemerverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isGemoedsbezwaardNationalInsurance":{"description":"Gemoedsbezwaard Volksverzekering","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isOnCallEmployment":{"description":"Indicates whether the employment is an on-call employment.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"isPreviousOwner":{"description":"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.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"namePayslip":{"description":"Name that is visible on payslips for the employment","example":"Steve Jobs","maxLength":34,"nullable":true,"readOnly":false,"type":"string"},"nonPayrollAdministration":{"description":"An administration that can not be used for payrolling. This field can not have a value at the same time as `payrollAdministration`\n\n`nonPayrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"participation55plusRegulationUWV":{"description":"Indicates whether the 55 plus regulation (55 plus regeling) is applicable for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"payrollAdministration":{"description":"An administration used for payrolling. This field can not have a value at the same time as `nonPayrollAdministration`\n\n`payrollAdministration` is a metadata field within the employer context. Possible values can be managed by the user. ","format":"metadata","nullable":true,"properties":{"clientNumber":{"description":"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.","example":1234,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"description":"Description of the administration","example":"Bakker","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"name":{"description":"Name of the administration","example":"ABC accountants","maxLength":70,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"periodPayGradeAdjustment":{"description":"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’.","example":2,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"professionCode":{"description":"A code field for a profession.","example":4,"format":"int32","nullable":true,"readOnly":false,"type":"integer"},"sendMdvNotification":{"description":"Indicate if a Mdv (melding dienstverband) should be send.","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"signalPayGradeAdjustment":{"description":"Indicates whether signaling regarding salary scale adjustments are enabled for the employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"specialIncomeRatio":{"description":"Indicates the special income ratio","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"startCancellationNoticePeriod":{"description":"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.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDate":{"description":"The date on which this employment starts.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"startDateContractOfIndefiniteDuration":{"description":"When did the value of `employmentDurationType` change for definite to indefinite. This value should be te samen as the `startDate` if the contract was indefinite from the start.","example":"2025-08-15T13:53:41.814Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"typeOfEmployee":{"description":"A selection of pre defined employee-types for the employment.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"typeOfParticipation":{"description":"The type of participation (aard van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"vacationCoupons":{"description":"Indication for vacation coupons (vakantiebonnen). This is only applies to a limited set of CLA`s.","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"valueOfParticipation":{"description":"The value of participation (waarde van deelnemerschap) is only applicable in case the person related to this employment is eligible for pension","format":"metadata","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"writtenEmploymentContract":{"description":"Dit the employment and employer make a written contract?","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"fiscalData":{"nullable":true,"properties":{"annualSalary":{"description":"The fiscal annual salary","example":60000,"format":"double","maximum":1000000000,"minimum":0,"nullable":true,"readOnly":false,"type":"number"},"applyDayTables":{"description":"Indicates whether the value of the day table is used for the calculation of payroll tax","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyDeviatingPayrollTaxPercentageOn":{"description":"Indicates on what type of payroll calculation the deviating payroll tax percentage is applicable","format":"metadata","nullable":false,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Afwijkend voor tabel- en tariefloon","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"applyPayrollTaxDeduction":{"description":"Indicates whether payroll tax deduction is appliclable (loonheffingskorting)","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"applyStudentDeduction":{"description":"Apply the \"Scholierenregeling\"","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingCalculationRulePayrollTax":{"description":"Indicates if, while calculating payroll taxes and social security contributions, certain deviations are applicable. NL; Herleidingsregel","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"deviatingPayrollTaxPercentage":{"description":"Indicates a deviating payroll tax percentage is to be applied","example":27.45,"format":"double","nullable":true,"readOnly":true,"type":"number"},"deviatingPayrollTaxTableColour":{"description":"Indicates if there is a deviating payroll tax table is applicable (green vs white table)","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Werknemer belastingpl. en niet premiepl. WLZ","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"residentOf":{"description":"Related to the fiscal country of residence of the employee. This might affect the calculation of any applicable loonheffingskortingen.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of document","example":"Andere EU-lidstaat,EER-land,Zwitserland of BES-eilanden","maxLength":80,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"organizationalEntityData":{"nullable":true,"properties":{"department":{"description":"The department of the employment.\n\n`department` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingFunctionDescription":{"description":"The deviating function description of the employment. This description deviates from the value of the `function` field.","example":"Directeur","nullable":true,"readOnly":false,"type":"string"},"deviatingFunctionGroup":{"description":"The deviating functiongroup description of the employment.","example":"9A","nullable":true,"readOnly":false,"type":"string"},"distributionUnit":{"description":"Distribution unit, used in several reports and the \"basic wage journal\" functionality. Commonly used as a cost center. \n\n`distributionUnit` is a metadata field within the employer context. Possible values can be managed by the user. \n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Sales","nullable":false,"readOnly":true,"type":"string"},"key":{"example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"function":{"description":"The function of the employment.\n\n`function` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"description":{"example":"Directeur","nullable":false,"readOnly":true,"type":"string"},"group":{"example":"internal","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"internalTelephoneExtensionNumber":{"description":"The phone extention number for the employment.","example":"0133031600","nullable":true,"readOnly":false,"type":"string"},"placeOfEmployment":{"description":"The place of employment (standplaats) for the employment.","example":"Amsterdam office","nullable":true,"readOnly":false,"type":"string"},"standardFunction":{"description":"The standard (cao)function of the employment.\n\n`standardFunction` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"category":{"example":1,"format":"int32","nullable":true,"readOnly":true,"type":"integer"},"code":{"example":"A21","maxLength":6,"minLength":1,"nullable":true,"readOnly":true,"type":"string"},"key":{"example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"Administrateur","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"otherPayrollVariablesData":{"nullable":true,"properties":{"deviatingPremiumGroup":{"description":"Indicates what deviating premie sector fonds should apply for the employment. Do not specify if there is no deviation from the premium group for the payroll administration the employment is linked to.","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(12) Metaal- en technische bedrijfstakken","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"selfService":{"properties":{"status":{"description":"Description of the status","enum":["HasAccessToClient","NoAccessToClient","UserIsBlocked","AccessToClientIsBlocked"],"maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"socialSecurityData":{"nullable":true,"properties":{"healthCareInsuranceActType":{"description":"Indicates what type of Health Care Insurance Act (Zvw) is applicable for this employment","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"(C/K) Wel verzekeringsplichtig, normaal tarief","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"isInsuredForOccupationalDisabilityInsuranceAct":{"description":"Will contributions for the Occupational Disability Insurance Act (WAO) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForSicknessBenefitsAct":{"description":"Will contributions for the Sickness Benefits Act (ZW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isInsuredForUnemploymentInsuranceAct":{"description":"Will contributions for the Unemployment Insurance Act (WW) be payed for this employment","example":false,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"uniqueName":{"description":"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.","example":"Sollicitant 013","maxLength":255,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"wageData":{"nullable":true,"properties":{"applyPayGrade":{"description":"Apply pay grade indicates that after submitting the record the server will replace the value of `grossWage` with the value represented by the selected `payGrade`. A pay grade contains time based values, the value that is active on the `start date` of the record will be selected. \n","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"grossWage":{"description":"The gross wage for the employee\n","example":23,"format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"grossWageType":{"description":"Indicates whether the `grossWage` is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in wagePeriodType.\n","format":"metadata","nullable":true,"properties":{"key":{"example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"netWage":{"description":"Net wage for the employment\n","format":"double","maximum":1000000,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"netWageType":{"description":"Indicates whether the net wage is an hourly wage or a periodic wage. Periodic can represent a week, four weeks or a month. Which period is active for the employment can be found in the payroll administration resource.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"hourly","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payGrade":{"description":"The pay grade indicates on what level (cel) of the paygrade the employment is. The level is multi dimensional where the description indicates both the level and for example the number of years of service within the given level. \n\n`payGrade` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Schaal B1, 15 jaar","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"payScale":{"description":"A pay scale (also known as a salary structure) is a system that determines how much an employee is to be paid as a wage or salary, based on one or more factors such as the employee\"s level, rank or status within the employer\"s organization, the length of time that the employee has been employed, and the difficulty of the specific work performed. After selecting a pay scale a pay grade needs to be selected to determine the actual wage. Only works with `grossWage`. The value of `grossWage` will be updated server side after the submit.\n\n`payScale` is a metadata field within the payroll administration/payScale context. Possible values can be managed by the user.\n","format":"metadata","nullable":true,"properties":{"key":{"example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"example":"Glastuinbouw maand, Loongebouw A","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"},"workingHoursData":{"nullable":true,"properties":{"averageParttimeFactor":{"description":"This field is used to register the deviating value of the parttimefactor. The parttimefactor is normally calculated by workinghours dividing by shifthours multplied by 100","example":37.5,"format":"double","maximum":999.99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"calculateUsingWorkPattern":{"description":"Indications in this objects determine whether specific values should be calculated based on the bi-weekly workPattern (specified in the `workPattern` object).","nullable":false,"properties":{"daysDailyRate":{"description":"Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"deviatingDaysAndHours":{"description":"Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)!","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursBrokenPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursPeriod":{"description":"Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods. ","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"leaveHours":{"description":"Indicates whether then leave balances (verlof) are to be calculated based on the workpattern.","example":true,"nullable":true,"readOnly":false,"type":"boolean"}},"type":"object"},"contractCode":{"description":"This field is specialy made for convenience stores. The field is the type of contract.\n\n`contractCode` is a metadata field within the employer context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"code":{"example":1022,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"SLA-PT-met toeslagen ATW (88)","nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"},"deviatingHoursPerWeek":{"description":"Fulltime hours are normally based as defined by the shift, this optional field is used to register a deviating value. The value can be less or more then the fulltime hours a week.","example":32,"format":"double","maximum":99,"minimum":0.01,"nullable":true,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"deviatingSvDaysPerPeriod":{"description":"Sv (social insurance) days are normally calculated by hours per shift, this optional field is used to register a deviating value. ","example":32,"maximum":23,"minimum":1,"nullable":true,"readOnly":false,"type":"number"},"flexibleHoursContract":{"description":"The field indicates the type of flexible contract. If not applicable, please set to NULL.","nullable":true,"properties":{"key":{"example":0,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"example":"n.v.t.","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"regularWorkPattern":{"description":"When the employee works the same amount of hours per day every week, then the workpattern is regular. ","example":true,"nullable":true,"readOnly":false,"type":"boolean"},"shift":{"description":"The shift determines the full-time hours and bonus percentage.\n\n`shift` is a metadata field within the payroll administration context. Possible values can be managed by the user.","format":"metadata","nullable":true,"properties":{"bonusPercentage":{"description":"The bonus percentage used in wage calculations for the hours made in this shift. ","example":12,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"fullTimeHoursPerWeek":{"description":"The full time hours for an employment that is linked to this shift.","example":40,"maximum":99,"minimum":0.01,"readOnly":true,"type":"number"},"shiftNumber":{"description":"The number for the shift. ","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"}},"type":"object"},"workPattern":{"description":"The applicable work pattern for a period of 2 weeks can be stored in this object. Each field contains the number of work hours for that day in the 2-week period.
Please note that the workPattern should be left NULL if no data is present (as opposed to filling all fields with 0)
Each field represent the number of hours the employee normally works on that day.\n","nullable":true,"properties":{"evenWeeks":{"properties":{"friday":{"example":2,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":8,"format":"double","maximum":24,"minimum":0,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"},"oddWeeks":{"properties":{"friday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"monday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"saturday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"sunday":{"example":0,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"thursday":{"example":7.5,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"tuesday":{"example":8,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"},"wednesday":{"example":4,"format":"double","maximum":24,"minimum":0,"nullable":false,"pattern":"^(\\d{1,2})(\\.\\d{1,2})?$","readOnly":false,"type":"number"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of a concept employee","tags":["Concept employee"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/assessment/initiate":{"post":{"description":"__Activity name :__ PostInitiateAssessmentByConceptEmployeeId\n\n__Metadata:__ No metadata available. No defaults available.\n\n\nInitiate the proces to perform an assessment for a concept employee.\n","operationId":"PostInitiateAssessmentByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"withIq":{"description":"The type of the assessment","example":true,"nullable":false,"readOnly":false,"type":"boolean"}}}}},"description":"Contactinformation of the assessment.","required":true},"responses":{"202":{"description":"Initiated"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Initiate assessment","tags":["Assessment"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/citizenservicenumber":{"get":{"description":"__Activity name :__ GetCitizenServiceNumberByConceptEmployeeId\n\nGet the citizen service number (BSN) of a concept employee. BSN is separately authorized in Loket and is therefore designed to have its own activities. \n","operationId":"GetCitizenServiceNumberByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"citizenServiceNumber":{"description":"The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN).","example":"042168588","maxLength":9,"minLength":9,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Citizen service number of a concept employee","tags":["Concept employee"]},"put":{"description":"__Activity name :__ PutCitizenServiceNumberByConceptEmployeeId\n\nUpdate the citizen service number (BSN) of a concept employee BSN is separately authorized in Loket and is therefore designed to have its own activities.\n","operationId":"PutCitizenServiceNumberByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"citizenServiceNumber":{"description":"The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN).","example":"042168588","maxLength":9,"minLength":9,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"}}},"description":"citizen service number to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"citizenServiceNumber":{"description":"The social security number of the employee used in communication with the Dutch tax authorities. The number has to be a valid Dutch citizen service number (BSN).","example":"042168588","maxLength":9,"minLength":9,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Update the citizen service number of a concept employee","tags":["Concept employee"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/convertToEmployee":{"patch":{"description":"__Activity name :__ PatchConvertToEmployeeByConceptEmployeeId\n\nThis endpoint \"converts\" the conceptEmployee to an actual employee in Loket. This means creating a number of records including Employee, Employment, WorkingHours, Wage etc. If the promotion is succesful the concept employee record will be deleted.\n\nThe GUID of the conceptEmployee will be copied over to the GUID of the newly created Employee.\n\nBefore performing these steps, quite a number of validations are performed to ensure that the provided information can be used to create a functionally valid employee.\n\n\nIf the employeeNumber is empty then this will be set automatically for the employee. (i.e. highest available number +1)\n\n__Additional functionality :__\n* It is possible to call an alternative functionality closely related to this functionality. This additional functionality will perform the validation ONLY, and it will NOT convert the conceptEmployee to an actual employee even when all validation rules are successful. Other than not performing the actual step of converting the employee the endpoint will behave identically to the actual endpoint.\n* This functionality can be applied by setting the optional X-ValidateOnly header to true\n","operationId":"PatchConvertToEmployeeByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"If set to true only the validations will be performed no changes will be committed.","in":"header","name":"X-ValidateOnly","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.814Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Convert a concept employee to an employee","tags":["Concept employee"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents":{"get":{"description":"__Activity name :__ GetDocumentsByConceptEmployeeId\n\nGet a list of documents within the concept employee's dossier (werknemerdossier). Via Qwoater.\n","operationId":"GetDocumentsByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"allOf":[{"allOf":[{"properties":{"attribute":{"description":"The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n","example":"VSP004","maxLength":250,"nullable":true,"readOnly":false,"type":"string"},"category":{"description":"The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType\n","example":"Arbeidsovereenkomst","format":"metadata","maxLength":4000,"nullable":false,"readOnly":false,"type":"string"},"dateOfAlert":{"description":"The time at which document will alerted for cancellation. Qwoater: AlertDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"dateOfSubmission":{"description":"The time at which document was submitted. Qwoater: CreationDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":false,"readOnly":true,"type":"string"},"description":{"description":"The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n","example":"Copy of id card","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"isReadBy":{"properties":{"departmentManager":{"description":"Qwoater: IsReadDepartmentManager","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employee":{"description":"Qwoater: IsReadEmployee","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employer":{"description":"Qwoater: IsReadEmployer","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"provider":{"description":"Qwoater: IsReadProvider","example":false,"nullable":false,"readOnly":true,"type":"boolean"}},"readOnly":true,"type":"object"},"qwoaterDocumentId":{"description":"Qwoater documentId","example":"","format":"uuid","nullable":false,"readOnly":true,"type":"string"},"submittedBy":{"description":"The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker\n","example":"Bowls, John","maxLength":4000,"nullable":true,"readOnly":true,"type":"string"},"year":{"description":"The year the document relates to. Qwoater: Docfield 86 Jaar\n","example":2017,"format":"int32","maximum":9999,"minimum":1000,"nullable":true,"readOnly":false,"type":"integer"}}},{"properties":{"filename":{"description":"The name of the file. Qwoater: Filename\n","example":"BowlsJohn.pdf","maxLength":255,"minLength":1,"nullable":false,"readOnly":false,"type":"string"}}}]},{"properties":{"isInitiateSignDocumentRequestPossible":{"description":"Indicates whether initiate sign document request is possible.\n","example":true,"nullable":true,"readOnly":true,"type":"boolean"},"signDocumentStatus":{"description":"Status of the signature.\n","format":"metadata","nullable":true,"properties":{"key":{"example":"Se","nullable":false,"readOnly":true,"type":"string"},"value":{"example":"Onderteken-verzoek verzonden","nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}]},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Get a list of concept employee dossier documents","tags":["Concept employee dossier"]},"post":{"description":"__Activity name :__ PostDocumentByConceptEmployeeId\n\n__Metadata:__ Possible options for fields of the type 'metadata' can be acquired(GET)by adding `/metadata` to the POST URL.\n\nUpload a document within the concept employee's dossier (werknemerdossier). Via Qwoater.\n","operationId":"PostDocumentByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"allOf":[{"properties":{"attribute":{"description":"The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n","example":"VSP004","maxLength":250,"nullable":true,"readOnly":false,"type":"string"},"category":{"description":"The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType\n","example":"Arbeidsovereenkomst","format":"metadata","maxLength":4000,"nullable":false,"readOnly":false,"type":"string"},"dateOfAlert":{"description":"The time at which document will alerted for cancellation. Qwoater: AlertDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"dateOfSubmission":{"description":"The time at which document was submitted. Qwoater: CreationDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":false,"readOnly":true,"type":"string"},"description":{"description":"The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n","example":"Copy of id card","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"isReadBy":{"properties":{"departmentManager":{"description":"Qwoater: IsReadDepartmentManager","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employee":{"description":"Qwoater: IsReadEmployee","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employer":{"description":"Qwoater: IsReadEmployer","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"provider":{"description":"Qwoater: IsReadProvider","example":false,"nullable":false,"readOnly":true,"type":"boolean"}},"readOnly":true,"type":"object"},"qwoaterDocumentId":{"description":"Qwoater documentId","example":"","format":"uuid","nullable":false,"readOnly":true,"type":"string"},"submittedBy":{"description":"The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker\n","example":"Bowls, John","maxLength":4000,"nullable":true,"readOnly":true,"type":"string"},"year":{"description":"The year the document relates to. Qwoater: Docfield 86 Jaar\n","example":2017,"format":"int32","maximum":9999,"minimum":1000,"nullable":true,"readOnly":false,"type":"integer"}}},{"properties":{"filename":{"description":"The name of the file. Qwoater: Filename\n","example":"BowlsJohn.pdf","maxLength":255,"minLength":1,"nullable":false,"readOnly":false,"type":"string"}}}]},{"properties":{"file":{"description":"base64 encoded document file.","example":"YQ==","nullable":false,"readOnly":false,"type":"string"}}}]}}},"description":"Document to be uploaded for the concept employee.","required":true},"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Upload a document to the concept employee dossier","tags":["Concept employee dossier"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}":{"delete":{"description":"__Activity name:__ DeleteDocumentByConceptEmployeeIdAndDocumentId\n\nDelete a document in the concept employee dossier\n","operationId":"DeleteDocumentByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the employment dossier document","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a document in the concept employee dossier","tags":["Concept employee dossier"]},"get":{"description":"__Activity name :__ GetDocumentByConceptEmployeeIdAndDocumentId\n\nDownload the file of a given concept employee dossier entry. Via Qwoater.\n","operationId":"GetDocumentByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the employment dossier document","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}}],"responses":{"200":{"description":"OK. Output type may be of any extension type that is supported by Qwoater."},"400":{"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Download concept employee dossier document","tags":["Concept employee dossier"]},"put":{"description":"__Activity name:__ PutDocumentByConceptEmployeeIdAndDocumentId\n\nEdit the details for a document in the concept employee dossier\n","operationId":"PutDocumentByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the employment dossier document","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"attribute":{"description":"The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n","example":"VSP004","maxLength":250,"nullable":true,"readOnly":false,"type":"string"},"category":{"description":"The category of the document. Provided value must be a valid metadata option. Qwoater: DocumentType\n","example":"Arbeidsovereenkomst","format":"metadata","maxLength":4000,"nullable":false,"readOnly":false,"type":"string"},"dateOfAlert":{"description":"The time at which document will alerted for cancellation. Qwoater: AlertDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"dateOfSubmission":{"description":"The time at which document was submitted. Qwoater: CreationDate\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":false,"readOnly":true,"type":"string"},"description":{"description":"The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n","example":"Copy of id card","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"isReadBy":{"properties":{"departmentManager":{"description":"Qwoater: IsReadDepartmentManager","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employee":{"description":"Qwoater: IsReadEmployee","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"employer":{"description":"Qwoater: IsReadEmployer","example":false,"nullable":false,"readOnly":true,"type":"boolean"},"provider":{"description":"Qwoater: IsReadProvider","example":false,"nullable":false,"readOnly":true,"type":"boolean"}},"readOnly":true,"type":"object"},"qwoaterDocumentId":{"description":"Qwoater documentId","example":"","format":"uuid","nullable":false,"readOnly":true,"type":"string"},"submittedBy":{"description":"The name of the user that has submitted the document. Qwoater: Docfield 34 Gebruiker\n","example":"Bowls, John","maxLength":4000,"nullable":true,"readOnly":true,"type":"string"},"year":{"description":"The year the document relates to. Qwoater: Docfield 86 Jaar\n","example":2017,"format":"int32","maximum":9999,"minimum":1000,"nullable":true,"readOnly":false,"type":"integer"}}}}},"description":"Document record to edit.","required":true},"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of an concept employee dossier document","tags":["Concept employee dossier"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/audittrail":{"get":{"description":"__Activity name :__ GetAuditTrailByConceptEmployeeIdAndDocumentId\n\nGet audittrail for the document in the concept employee dossier.\n","operationId":"GetAuditTrailByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the employment dossier document","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"attribute":{"description":"Qwoater: Kenmerk\n","example":"","nullable":true,"readOnly":true,"type":"string"},"category":{"description":"Qwoater: DocumentType\n","example":"","nullable":true,"readOnly":true,"type":"string"},"dateOfAlert":{"description":"The time the declaration was submitted. Qwoater: Signaleringsdatum\n","example":"2025-08-15T13:53:41.815Z","format":"date","nullable":true,"readOnly":true,"type":"string"},"description":{"description":"Qwoater: Omschrijving\n","example":"VSP004","nullable":true,"readOnly":true,"type":"string"},"endUser":{"description":"Qwoater: EndUser\n","example":"Hur, Ben","nullable":true,"readOnly":true,"type":"string"},"event":{"description":"Qwoater: Event\n","example":"Audittrail opgevraagd","nullable":false,"readOnly":true,"type":"string"},"eventDate":{"description":"The time the declaration was submitted. Qwoater: AuditEventDate\n","example":"2025-08-15T13:53:41.815Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"},"role":{"description":"Qwoater: Role\n","example":"Provider","nullable":false,"readOnly":true,"type":"string"},"year":{"description":"Qwoater: Jaar\n","example":"2020","nullable":true,"readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Get audittrail for the document in the concept employee dossier","tags":["Concept employee dossier"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature":{"delete":{"description":"__Activity name :__ DeleteSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nDelete the proces to sign a document for an Conceptemployee.\n","operationId":"DeleteSignatureByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"description":"OK."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete signature - Conceptemployee","tags":["Sign document"]},"get":{"description":"__Activity name :__ GetSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nRetrieve the status of the signing.\n","operationId":"GetSignatureByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"properties":{"signDocumentStatus":{"description":"Status of the signature at document level","nullable":false,"properties":{"Key":{"description":"The key of the status","example":"Ne","type":"string"},"Value":{"description":"The description of the status.","example":"Nieuw onderteken-verzoek","type":"string"}},"type":"object"},"signerStatus":{"items":{"description":"Status of the signature per signer","nullable":true,"properties":{"declined":{"description":"Has the signer declined to sign the document?","example":true,"type":"boolean"},"emailAddress":{"description":"The email address of the signer.","example":"test@test.com","type":"string"},"emailed":{"description":"Has the signer received an email to sign the document?","example":true,"type":"boolean"},"name":{"description":"The name of the signer","example":"Ben Hur","type":"string"},"signed":{"description":"Has the signer received an email to sign the document?","example":true,"type":"boolean"},"signedOnDate":{"description":"The date/time at which the signer has signed the document","example":"2025-08-15T13:53:41.815Z","format":"date-time","nullable":true,"type":"string"},"viewed":{"description":"Has the signer viewed the document?","example":true,"type":"boolean"}},"type":"object"},"type":"array"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.815Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Signature details - Conceptemployee","tags":["Sign document"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/initiate":{"post":{"description":"__Activity name :__ PostInitiateSignatureByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available. Defaults are available by adding /defaults to the path.\n\nInitiate the proces to sign a document for an employment by one or more signers.\n","operationId":"PostInitiateSignatureByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"items":{"properties":{"emailAddress":{"description":"The email address of the signer.","example":"test@test.com","maximum":255,"minimum":1,"nullable":false,"readOnly":false,"type":"string"},"mobilePhoneNumber":{"description":"The mobile phone number of the signer. In E.164 format","example":"+31612345678","nullable":false,"readOnly":false,"type":"string"},"name":{"description":"The name of the signer","example":"Ben Hur","maximum":255,"minimum":1,"nullable":false,"readOnly":false,"type":"string"},"signingOrder":{"description":"When filled, this integer is used to set the order in which the signers have to sign the document. An email will be sent to all signers with the first SigningOrder number. When signed an email will be sent to all signers with the second SingingOrder. Etcetera.","example":"2","nullable":true,"readOnly":false,"type":"integer"}}},"type":"array"}}},"description":"Contactinformation of the signers.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"signDocumentStatus":{"description":"Status of the signature at document level","nullable":false,"properties":{"Key":{"description":"The key of the status","example":"Ne","type":"string"},"Value":{"description":"The description of the status.","example":"Nieuw onderteken-verzoek","type":"string"}},"type":"object"}}}},"type":"object"}]}}},"description":"Initiated"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Initiate signature - Conceptemployee","tags":["Sign document"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/report":{"get":{"description":"__Activity name :__ GetSignatureReportByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ No metadata available.\n\nReport of the signature.\n","operationId":"GetSignatureReportByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Retrieve the report of the signing - Conceptemployee","tags":["Sign document"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocument":{"post":{"description":"__Activity name :__ PostGenerateDocumentByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{conceptEmployeeId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an concept employee and store it in the employment dossier. Via Qwoater.\n","operationId":"PostGenerateDocumentByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"attribute":{"description":"The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n","example":"VSP004","maxLength":250,"nullable":true,"readOnly":false,"type":"string"},"dateOfAlert":{"description":"The date at which document will alerted for cancellation. Qwoater: AlertDate\n","example":"2025-08-15T13:53:41.816Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"description":{"description":"The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n","example":"Copy of id card","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"filename":{"description":"The name of the file. Qwoater: Filename\n","example":"BowlsJohn.pdf","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"referenceDate":{"description":"This date will be used to select date depending data such as department and function.\n","example":"2025-08-15T13:53:41.816Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"templateEmployerId":{"description":"The unique identifier of the employer to which the template belongs (GUID/UUID).","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"year":{"description":"The year the document relates to. Qwoater: Docfield 86 Jaar\n","example":2017,"format":"int32","maximum":9999,"minimum":1000,"nullable":true,"readOnly":false,"type":"integer"}}}}},"description":"Metadata for the document to be generated.","required":true},"responses":{"200":{"description":"OK. Document is generated and stored."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Generate a document for an concept employee","tags":["Generate document"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/documenttemplates/{documentId}/generatedocument/preview":{"post":{"description":"__Activity name :__ PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId\n\n__Metadata:__ Available templates can be acquired(GET) at Employer level(/v2/providers/employers/{employerId}/documenttemplates/generatedocument/metadata).\n\nGenerate a document for an concept employee and receive a preview. Via Qwoater.\n","operationId":"PostGenerateDocumentPreviewByConceptEmployeeIdAndDocumentId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the template","example":"P123456789","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"attribute":{"description":"The attribute defined by the submitter. Qwoater: Docfield 32 Kenmerk\n","example":"VSP004","maxLength":250,"nullable":true,"readOnly":false,"type":"string"},"dateOfAlert":{"description":"The date at which document will alerted for cancellation. Qwoater: AlertDate\n","example":"2025-08-15T13:53:41.816Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"description":{"description":"The description defined by the submitter. Qwoater: Docfield 33 Omschrijving\n","example":"Copy of id card","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"filename":{"description":"The name of the file. Qwoater: Filename\n","example":"BowlsJohn.pdf","maxLength":250,"minLength":1,"nullable":false,"readOnly":false,"type":"string"},"referenceDate":{"description":"This date will be used to select date depending data such as department and function.\n","example":"2025-08-15T13:53:41.816Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"templateEmployerId":{"description":"The unique identifier of the employer to which the template belongs (GUID/UUID).","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"},"year":{"description":"The year the document relates to. Qwoater: Docfield 86 Jaar\n","example":2017,"format":"int32","maximum":9999,"minimum":1000,"nullable":true,"readOnly":false,"type":"integer"}}}}},"description":"Metadata for the document to be generated.","required":true},"responses":{"200":{"content":{"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schema":{"format":"binary","type":"string"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Generate a document for an concept employee - preview","tags":["Generate document"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/dossier\"":{"delete":{"description":"__Activity name:__ DeleteDossierByConceptEmployeeId\n\nDelete a complete dossier, with all documents in it, for the concept employee\n","operationId":"DeleteDossierByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete the complete concept employee dossier","tags":["Concept employee dossier"]},"get":{"description":"__Activity name :__ GetDocumentCountByConceptEmployeeId\n\nGet a count of the number of documents in the dossier. Via Qwoater.\n","operationId":"GetDocumentCountByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"numberOfDocuments":{"description":"The number of documents in the dossier, regarthless of who has access to them.","example":7,"format":"int32","nullable":false,"readOnly":true,"type":"integer"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Document count","tags":["Concept employee dossier"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/preboardingtrajectory":{"patch":{"description":"__Activity name :__ PatchPreboardingTrajectoryByConceptEmployeeId\n","operationId":"PatchPreboardingTrajectoryByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"action":{"description":"The action to perform on PreboardingTrajectory","enum":["markAsCompleted","markAsEndedPrematurely"],"nullable":false,"readOnly":false,"type":"string"}},"required":["action"],"type":"object"}}},"description":"New status","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"type":"object"}},"type":"object"}]}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Change status of a preboarding trajectory","tags":["Preboarding trajectory"]},"post":{"description":"__Activity name :__ PostPreboardingTrajectoryByConceptEmployeeId\n","operationId":"PostPreboardingTrajectoryByConceptEmployeeId","parameters":[{"description":"The unique identifier of the concept employee","in":"path","name":"conceptEmployeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"id":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}},"type":"object"}}},"description":"None","required":true},"responses":{"201":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.816Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"id":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Add a preboarding trajectory","tags":["Preboarding trajectory"]}},"/providers/employers/conceptemployees/{conceptEmployeeId}/selfservice":{"get":{"description":"__Activity name :__ GetConceptEmployeeSelfServiceByConceptEmployeeId\n\nGet the details of a Concept employee with regards to ESS access\n","operationId":"GetConceptEmployeeSelfServiceByConceptEmployeeId","parameters":[{"description":"The unique identifier of the employee","in":"query","name":"employeeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}},{"description":"Automatically added","in":"path","name":"conceptEmployeeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"conceptEmployee":{"properties":{"emailAddress":{"description":"The e-mail address of the employee.","example":"info@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"employeeNumber":{"description":"The employee number to uniquely identify a employee within an employer.","example":156,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"firstName":{"description":"The first name of the employee","example":"Susan","maxLength":28,"nullable":true,"readOnly":true,"type":"string"},"formattedName":{"description":"Formatted name of the employee based on the value of `howToFormatLastName`","example":"Wiel - van Bergen S.L. van de","maxLength":82,"nullable":false,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"initials":{"description":"The initials of the employee","example":"S.L.","maxLength":6,"nullable":false,"readOnly":true,"type":"string"},"lastName":{"description":"The last name of the employee","example":"Bergen","maxLength":25,"nullable":false,"readOnly":true,"type":"string"},"prefix":{"description":"The prefix of the employee","example":"van","maxLength":10,"nullable":true,"readOnly":true,"type":"string"}},"type":"object"},"status":{"description":"Description of the status","enum":["HasAccessToClient","NoAccessToClient","UserIsBlocked","AccessToClientIsBlocked"],"maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a Concept employee self service portal status","tags":["Concept employee self service"]}},"/providers/employers/contractcodes/{contractCodeId}":{"delete":{"description":"__Activity name :__ DeleteContractCodeByContractCodeId\n\n\nDelete an existing contract code record\n","operationId":"DeleteContractCodeByContractCodeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"contractCodeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a contract code record","tags":["Contract code"]},"get":{"description":"__Activity name :__ GetContractCodeByContractCodeId\n\n\nGet the details of a contract code\n","operationId":"GetContractCodeByContractCodeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"contractCodeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"code":{"description":"An unique code for the contract code within the scope of the employer","example":1022,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"description":{"description":"The description of the contract code","example":"Special contract","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a contract code","tags":["Contract code"]},"put":{"description":"__Activity name :__ PutContractCodeByContractCodeId\n","operationId":"PutContractCodeByContractCodeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"contractCodeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"code":{"description":"An unique code for the contract code within the scope of the employer","example":1022,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"description":{"description":"The description of the contract code","example":"Special contract","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"code":{"description":"An unique code for the contract code within the scope of the employer","example":1022,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"description":{"description":"The description of the contract code","example":"Special contract","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit a contract code record","tags":["Contract code"]}},"/providers/employers/customfields/{customFieldId}":{"delete":{"description":"__Activity name :__ DeleteCustomFieldByCustomFieldId\n\nDelete an existing custom field record\n","operationId":"DeleteCustomFieldByCustomFieldId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customFieldId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a custom field record","tags":["Custom field"]},"get":{"description":"__Activity name :__ GetCustomFieldByCustomFieldId\n\nGet the details of a custom field\n","operationId":"GetCustomFieldByCustomFieldId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customFieldId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"description":{"description":"The description for the custom field which can be used at the employee and employment level","example":"Shoe size","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a custom field","tags":["Custom field"]},"put":{"description":"__Activity name :__ PutCustomFieldByCustomFieldId\n","operationId":"PutCustomFieldByCustomFieldId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customFieldId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"description":{"description":"The description for the custom field which can be used at the employee and employment level","example":"Shoe size","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"description":{"description":"The description for the custom field which can be used at the employee and employment level","example":"Shoe size","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.817Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit a custom field record","tags":["Custom field"]}},"/providers/employers/customholidays/{customHolidayId}":{"delete":{"description":"__Activity name :__ DeleteCustomHolidayByCustomHolidayId\n\nDelete an existing custom holiday record\n","operationId":"DeleteCustomHolidayByCustomHolidayId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customHolidayId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a custom holiday record","tags":["Custom holiday"]},"get":{"description":"__Activity name :__ GetCustomHolidayByCustomHolidayId\n\nGet the details of a custom holiday\n","operationId":"GetCustomHolidayByCustomHolidayId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customHolidayId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"date":{"description":"The date for the custom holiday.","example":"2025-08-15T13:53:41.818Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"description":{"description":"The description for the custom holiday.","example":"Company 100th year anniversary","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a custom holiday","tags":["Custom holiday"]},"put":{"description":"__Activity name :__ PutCustomHolidayByCustomHolidayId\n","operationId":"PutCustomHolidayByCustomHolidayId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"customHolidayId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"date":{"description":"The date for the custom holiday.","example":"2025-08-15T13:53:41.818Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"description":{"description":"The description for the custom holiday.","example":"Company 100th year anniversary","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"date":{"description":"The date for the custom holiday.","example":"2025-08-15T13:53:41.818Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"description":{"description":"The description for the custom holiday.","example":"Company 100th year anniversary","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit a custom holiday record","tags":["Custom holiday"]}},"/providers/employers/departments/{departmentId}":{"get":{"description":"__Activity name:__ GetDepartmentByDepartmentId\n\nGet the details of department\n","operationId":"GetDepartmentByDepartmentId","parameters":[{"description":"The unique identifier of the department","in":"path","name":"departmentId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"code":{"description":"The visible identifier of the department.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"description":{"description":"The visible description (i.e. name) of the department.\n","example":"Verkoop Binnendienst","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests. Typically this is the mailadress of a manager that would get a notification mail when a new leave requet is to be processed.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"subDepartmentOf":{"description":"If the department is a sub department (i.e. underlying) of another department, then the key-field of that other department may be entered here.\n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop Algemeen","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a department","tags":["Departments"]},"put":{"description":"__Activity name:__ PutDepartmentByDepartmentId\n\nEdit the details for a department\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n","operationId":"PutDepartmentByDepartmentId","parameters":[{"description":"The unique identifier of the department","in":"path","name":"departmentId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"description":{"description":"The visible description (i.e. name) of the department.\n","example":"Verkoop Binnendienst","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests. Typically this is the mailadress of a manager that would get a notification mail when a new leave requet is to be processed.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"subDepartmentOf":{"description":"If the department is a sub department (i.e. underlying) of another department, then the key-field of that other department may be entered here.\n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop Algemeen","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}}},"description":"Department to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"code":{"description":"The visible identifier of the department.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"description":{"description":"The visible description (i.e. name) of the department.\n","example":"Verkoop Binnendienst","maxLength":50,"nullable":false,"readOnly":false,"type":"string"},"emailLeaveRequest":{"description":"Recipient e-mail adress for notification in case of leave requests. Typically this is the mailadress of a manager that would get a notification mail when a new leave requet is to be processed.","example":"api@loket.nl","maxLength":255,"nullable":true,"readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"subDepartmentOf":{"description":"If the department is a sub department (i.e. underlying) of another department, then the key-field of that other department may be entered here.\n","format":"metadata","nullable":true,"properties":{"code":{"example":2,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"description":{"example":"Verkoop Algemeen","maxLength":50,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The unique identifier of an object (GUID/UUID)\n","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":false,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of a department","tags":["Departments"]}},"/providers/employers/educationfurtherindications/{educationFurtherIndicationId}":{"delete":{"description":"__Activity name :__ DeleteEducationFurtherIndicationByEducationFurtherIndicationId\n\nDelete an existing education further indication record\n","operationId":"DeleteEducationFurtherIndicationByEducationFurtherIndicationId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationFurtherIndicationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete an education further indication record","tags":["Education further indication"]},"get":{"description":"__Activity name :__ GetEducationFurtherIndicationByEducationFurtherIndicationId\n\nGet the details of an education further indication\n","operationId":"GetEducationFurtherIndicationByEducationFurtherIndicationId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationFurtherIndicationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"code":{"description":"An unique code for the eduction further indication within the scope of the employer","example":"lts","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education furhter indication","example":"Lagere technische school","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of an education further indication","tags":["Education further indication"]},"put":{"description":"__Activity name :__ PutEducationFurtherIndicationByEducationFurtherIndicationId\n","operationId":"PutEducationFurtherIndicationByEducationFurtherIndicationId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationFurtherIndicationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"code":{"description":"An unique code for the eduction further indication within the scope of the employer","example":"lts","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education furhter indication","example":"Lagere technische school","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"code":{"description":"An unique code for the eduction further indication within the scope of the employer","example":"lts","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education furhter indication","example":"Lagere technische school","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit an education further indication record","tags":["Education further indication"]}},"/providers/employers/educationtypes/{educationTypeId}":{"delete":{"description":"__Activity name :__ DeleteEducationTypeByEducationTypeId\n\nDelete an existing education type record\n","operationId":"DeleteEducationTypeByEducationTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.818Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete an education type record","tags":["Education type"]},"get":{"description":"__Activity name :__ GetEducationTypeByEducationTypeId\n\nGet the details of an education type\n","operationId":"GetEducationTypeByEducationTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"code":{"description":"An unique code for the eduction type within the scope of the employer","example":"WO","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education type","example":"Wetenschappelijk onderwijs","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of an education type","tags":["Education type"]},"put":{"description":"__Activity name :__ PutEducationTypeByEducationTypeId\n","operationId":"PutEducationTypeByEducationTypeId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"educationTypeId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"code":{"description":"An unique code for the eduction type within the scope of the employer","example":"WO","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education type","example":"Wetenschappelijk onderwijs","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"code":{"description":"An unique code for the eduction type within the scope of the employer","example":"WO","maxLength":10,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"description":{"description":"The description of the education type","example":"Wetenschappelijk onderwijs","maxLength":50,"minLength":1,"nullable":false,"pattern":"^[\\s\\S]*\\S[\\s\\S]*$","readOnly":false,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit an education type record","tags":["Education type"]}},"/providers/employers/emailidentities/{emailIdentityId}":{"delete":{"description":"__Activity name:__ DeleteEmailIdentityByEmailIdentityId\n \n\nDelete an EmailIdentity for an employer. An EmailIdentity can only be deleted when it's not used in an emailTemplate.\n","parameters":[{"description":"The emailIdentity.","in":"path","name":"emailIdentityId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete an EmailIdentity for an employer","tags":["Email Identities"]}},"/providers/employers/emailidentities/{emailIdentityId}/sendtestemail":{"post":{"description":"__Activity name:__ PostSendEmployerTestemailByEmailIdentityId\n \n\nSend an email to test the email identity configuration. \n","operationId":"PostSendEmployerTestemailByEmailIdentityId","parameters":[{"description":"The emailIdentity.","in":"path","name":"emailIdentityId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"nullable":true,"properties":{"to":{"description":"The emailadres to which a test email should be send.","example":"user@provider.com","nullable":false,"readOnly":false,"type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"description":"OK. The test email has been sent."},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Employer emailIdentity test email","tags":["Email Identities"]}},"/providers/employers/employees/absences/absencecontactHistory/{absencecontactHistoryId}":{"delete":{"description":"__Activity name :__ DeleteAbsenceContactHistoryByAbsenceContactHistoryId\n\nDelete an existing record from the contact history\n","operationId":"DeleteAbsenceContactHistoryByAbsenceContactHistoryId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"absencecontactHistoryId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a specific record","tags":["Contact history"]},"get":{"description":"__Activity name :__ GetAbsenceContactHistoryByAbsenceContactHistoryId\n\nGet the details of a contact \n","operationId":"GetAbsenceContactHistoryByAbsenceContactHistoryId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"absencecontactHistoryId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.819Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of a contact history","tags":["Contact history"]},"put":{"description":"__Activity name :__ PutAbsenceContactHistoryByAbsenceContactHistoryId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of a contact history\n","operationId":"PutAbsenceContactHistoryByAbsenceContactHistoryId","parameters":[{"description":"The unique identifier of the record","in":"path","name":"absencecontactHistoryId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.819Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}}}},"description":"Absence progress to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.819Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of a contact history","tags":["Contact history"]}},"/providers/employers/employees/absences/absenceprogress/{absenceProgressId}":{"delete":{"description":"__Activity name :__ DeleteAbsenceProgressByAbsenceProgressId\n\nDelete an existing Absence Progress (for an employee). There always has to remain one record of absence progress for an absence. This last record is removed when the absence is deleted.\n","operationId":"DeleteAbsenceProgressByAbsenceProgressId","parameters":[{"description":"The unique identifier of an absence progress","in":"path","name":"absenceProgressId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a specific Absence Progress record","tags":["Absence Progress"]},"get":{"description":"__Activity name :__ GetAbsenceProgressByAbsenceProgressId\n\nGet the details of an Absence Progress \n","operationId":"GetAbsenceProgressByAbsenceProgressId","parameters":[{"description":"The unique identifier of an absence progress","in":"path","name":"absenceProgressId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.819Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.819Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of an Absence Progress","tags":["Absence Progress"]},"put":{"description":"__Activity name :__ PutAbsenceProgressByAbsenceProgressId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of an absence progress\n","operationId":"PutAbsenceProgressByAbsenceProgress","parameters":[{"description":"The unique identifier of an absence progress","in":"path","name":"absenceProgressId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.819Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}}},"description":"Absence progress to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of an absence progress","tags":["Absence Progress"]}},"/providers/employers/employees/absences/{absenceId}":{"delete":{"description":"__Activity name :__ DeleteAbsenceByAbsenceId\n\nDelete an existing absence (for an employee). If succesfull, this function also deletes the underlying absence progress records\n","operationId":"DeleteAbsenceByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Delete a specific absence record","tags":["Absence"]},"get":{"description":"__Activity name :__ GetAbsenceByAbsenceId\n\nGet the details of an Absence \n","operationId":"GetAbsenceByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"accidentType":{"description":"The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the accident type. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the accident type.","example":"work related accident","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"actionToBeTakenByOccupationalHealthAndSafetyService":{"description":"The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst).\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the desired action to be taken by the occupational health and safety service. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the desired action to be taken by the occupational health and safety service.","example":"Spoedcontrole aan huis","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"caseManager":{"nullable":true,"properties":{"function":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":50,"nullable":true,"readOnly":false,"type":"string"},"name":{"description":"Name of the case manager for reintegration.","example":"Ben Hur","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"organization":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":70,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"causeOfAbsence":{"description":"The cause of the absence. This endpoint is intended for the registration of two types of absence:\n\n 1) Illness/sickness\n\n 2) \"Vangnet\" such as maternity leave, organ donation or adoption leave\n\n\nOther absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the cause of the absence. Possible values can be acquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the cause of the absence.","example":"maternity leave","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"contactInformation":{"nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"endDate":{"description":"end date of the contact information","format":"date","nullable":true,"readOnly":false,"type":"string"},"furtherIndication":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the further indication. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The description of the further indication, the posible values are \"WW\" and \"AB\"","example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"locationType":{"description":"soort verpleegadres","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the location type. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of location type","example":"Hospital","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"name":{"description":"name of the institute for the contact information.","example":"RadboudUMC Nijmegen","maxLength":70,"minLength":1,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number to contact the employee on.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"startDate":{"description":"start date of the contact information","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}},"required":["startDate","country","street","city","postalCode","houseNumber"],"type":"object"},"expectedDateOfChildbirth":{"description":"Bevallingsdatum","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"expectedDuration":{"description":"The expected duration of the absence. If the expected duration is unknown, this field will be NULL.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the expected duration of the absence. Possible values can be acquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the expected duration of the absence.","example":"Minder dan 1 week","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"expectedEndDateOfMaternityLeave":{"description":"verwachte datum einde zwangerschapsverlof","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"hasMobilityIssue":{"description":"This field indicates whether the Employee has an issue limiting its mobility.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursWorkedOnFirstDayOfAbsence":{"description":"The number of hours worked on the first day of the absence.","example":3,"maximum":8,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"isDisruptedEmploymentRelationship":{"description":"Indicates whether the employement relationship between employee and employer is disrupted.","example":true,"nullable":false,"readOnly":false,"type":"boolean"},"isHospitalised":{"description":"Betreft het een ziekenhuisopnamen","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isRecoveredWithinTwoWeeks":{"description":"This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery.","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"isThirdPartyLiability":{"description":"This field is related to `accidentType`. \nWhen `accidentType` is specified, this field indicates whether a third party is liable for the accident.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isWorkRelatedIllness":{"description":"Beroepsziekte","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"progress":{"properties":{"currentIncapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":true,"type":"integer"},"endOfAbsence":{"description":"date and reason for the closing/end of the absence","format":"metadata","nullable":true,"properties":{"date":{"description":"The last day of the absence.\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"reason":{"description":"redenhersteld","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"description":"Description of the reason why the absence ended.","example":"Fully recoverd","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"readOnly":true,"type":"object"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"reintegration":{"nullable":true,"properties":{"dateOfFinalizingPlanOfAction":{"description":"The day on which a plan of action (for return to normal work) was finalized.\n","format":"date","nullable":false,"readOnly":false,"type":"string"},"reintegrationGoal":{"format":"metadata","nullable":false,"properties":{"key":{"description":"The key for the reintegration goal. Related to the Wet Verbetering Poortwachter.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Werkhervatting in de eigen functie","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK","headers":{"ETag":{"description":"The etag for concurrency control. If a PUT is performed this value has to be supplied in the if-match header of the request.\n","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Details of an Absence","tags":["Absence"]},"put":{"description":"__Activity name :__ PutAbsenceByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the PUT URL.\n\nEdit the details of am Absence\n","operationId":"PutAbsenceByAbsence","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"properties":{"accidentType":{"description":"The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the accident type. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the accident type.","example":"work related accident","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"actionToBeTakenByOccupationalHealthAndSafetyService":{"description":"The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst).\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the desired action to be taken by the occupational health and safety service. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the desired action to be taken by the occupational health and safety service.","example":"Spoedcontrole aan huis","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"caseManager":{"nullable":true,"properties":{"function":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":50,"nullable":true,"readOnly":false,"type":"string"},"name":{"description":"Name of the case manager for reintegration.","example":"Ben Hur","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"organization":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":70,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"causeOfAbsence":{"description":"The cause of the absence. This endpoint is intended for the registration of two types of absence:\n\n 1) Illness/sickness\n\n 2) \"Vangnet\" such as maternity leave, organ donation or adoption leave\n\n\nOther absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the cause of the absence. Possible values can be acquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the cause of the absence.","example":"maternity leave","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"contactInformation":{"nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"endDate":{"description":"end date of the contact information","format":"date","nullable":true,"readOnly":false,"type":"string"},"furtherIndication":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the further indication. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The description of the further indication, the posible values are \"WW\" and \"AB\"","example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"locationType":{"description":"soort verpleegadres","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the location type. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of location type","example":"Hospital","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"name":{"description":"name of the institute for the contact information.","example":"RadboudUMC Nijmegen","maxLength":70,"minLength":1,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number to contact the employee on.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"startDate":{"description":"start date of the contact information","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}},"required":["startDate","country","street","city","postalCode","houseNumber"],"type":"object"},"expectedDateOfChildbirth":{"description":"Bevallingsdatum","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"expectedDuration":{"description":"The expected duration of the absence. If the expected duration is unknown, this field will be NULL.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the expected duration of the absence. Possible values can be acquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the expected duration of the absence.","example":"Minder dan 1 week","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"expectedEndDateOfMaternityLeave":{"description":"verwachte datum einde zwangerschapsverlof","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"hasMobilityIssue":{"description":"This field indicates whether the Employee has an issue limiting its mobility.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursWorkedOnFirstDayOfAbsence":{"description":"The number of hours worked on the first day of the absence.","example":3,"maximum":8,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"isDisruptedEmploymentRelationship":{"description":"Indicates whether the employement relationship between employee and employer is disrupted.","example":true,"nullable":false,"readOnly":false,"type":"boolean"},"isHospitalised":{"description":"Betreft het een ziekenhuisopnamen","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isRecoveredWithinTwoWeeks":{"description":"This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery.","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"isThirdPartyLiability":{"description":"This field is related to `accidentType`. \nWhen `accidentType` is specified, this field indicates whether a third party is liable for the accident.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isWorkRelatedIllness":{"description":"Beroepsziekte","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"progress":{"properties":{"currentIncapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":true,"type":"integer"},"endOfAbsence":{"description":"date and reason for the closing/end of the absence","format":"metadata","nullable":true,"properties":{"date":{"description":"The last day of the absence.\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"reason":{"description":"redenhersteld","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"description":"Description of the reason why the absence ended.","example":"Fully recoverd","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"readOnly":true,"type":"object"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"reintegration":{"nullable":true,"properties":{"dateOfFinalizingPlanOfAction":{"description":"The day on which a plan of action (for return to normal work) was finalized.\n","format":"date","nullable":false,"readOnly":false,"type":"string"},"reintegrationGoal":{"format":"metadata","nullable":false,"properties":{"key":{"description":"The key for the reintegration goal. Related to the Wet Verbetering Poortwachter.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Werkhervatting in de eigen functie","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"Absence to edit.","required":true},"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"accidentType":{"description":"The type of accident that led to the absence. This field will be NULL if the absence is not related to an accident.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the accident type. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the accident type.","example":"work related accident","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"actionToBeTakenByOccupationalHealthAndSafetyService":{"description":"The desired action to be taken regarding the absence by the occupational health and safety service (arbodienst).\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the desired action to be taken by the occupational health and safety service. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the desired action to be taken by the occupational health and safety service.","example":"Spoedcontrole aan huis","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"caseManager":{"nullable":true,"properties":{"function":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":50,"nullable":true,"readOnly":false,"type":"string"},"name":{"description":"Name of the case manager for reintegration.","example":"Ben Hur","maxLength":25,"nullable":false,"readOnly":false,"type":"string"},"organization":{"description":"Function of the case manager.","example":"Ben Hur","maxLength":70,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number of the employee.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"}},"type":"object"},"causeOfAbsence":{"description":"The cause of the absence. This endpoint is intended for the registration of two types of absence:\n\n 1) Illness/sickness\n\n 2) \"Vangnet\" such as maternity leave, organ donation or adoption leave\n\n\nOther absences such as Vacation days, unpayed leave and Personal leave are registerd using the leave endpoint\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the cause of the absence. Possible values can be acquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the cause of the absence.","example":"maternity leave","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"contactInformation":{"nullable":true,"properties":{"city":{"description":"City of the address","example":"Leiden","maxLength":24,"nullable":false,"readOnly":false,"type":"string"},"country":{"format":"metadata","nullable":false,"properties":{"isoCode":{"description":"The ISO 3166-1 alpha-2 value for the country","example":"NL","maxLength":2,"nullable":false,"readOnly":true,"type":"string"},"key":{"description":"The key for the country. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Netherlands","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"endDate":{"description":"end date of the contact information","format":"date","nullable":true,"readOnly":false,"type":"string"},"furtherIndication":{"format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the further indication. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The description of the further indication, the posible values are \"WW\" and \"AB\"","example":"WW","nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"houseNumber":{"description":"House number of the address","example":12,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"houseNumberAddition":{"description":"An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number.","example":"D","maxLength":4,"nullable":true,"readOnly":false,"type":"string"},"locationType":{"description":"soort verpleegadres","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the location type. Posible values can be aquired via the metadata endpoint","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of location type","example":"Hospital","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"name":{"description":"name of the institute for the contact information.","example":"RadboudUMC Nijmegen","maxLength":70,"minLength":1,"nullable":true,"readOnly":false,"type":"string"},"phoneNumber":{"description":"The phone number to contact the employee on.","example":"+31 13-1234567","maxLength":15,"nullable":true,"readOnly":false,"type":"string"},"postalCode":{"description":"The postal code of the address","example":"1234 AA","maxLength":9,"nullable":false,"readOnly":false,"type":"string"},"startDate":{"description":"start date of the contact information","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"street":{"description":"Streetname of the address","example":"Voordijk","maxLength":24,"nullable":false,"readOnly":false,"type":"string"}},"required":["startDate","country","street","city","postalCode","houseNumber"],"type":"object"},"expectedDateOfChildbirth":{"description":"Bevallingsdatum","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"expectedDuration":{"description":"The expected duration of the absence. If the expected duration is unknown, this field will be NULL.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the expected duration of the absence. Possible values can be acquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the expected duration of the absence.","example":"Minder dan 1 week","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"expectedEndDateOfMaternityLeave":{"description":"verwachte datum einde zwangerschapsverlof","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":true,"readOnly":false,"type":"string"},"hasMobilityIssue":{"description":"This field indicates whether the Employee has an issue limiting its mobility.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"hoursWorkedOnFirstDayOfAbsence":{"description":"The number of hours worked on the first day of the absence.","example":3,"maximum":8,"minimum":1,"nullable":true,"readOnly":false,"type":"integer"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"isDisruptedEmploymentRelationship":{"description":"Indicates whether the employement relationship between employee and employer is disrupted.","example":true,"nullable":false,"readOnly":false,"type":"boolean"},"isHospitalised":{"description":"Betreft het een ziekenhuisopnamen","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isRecoveredWithinTwoWeeks":{"description":"This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery.","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"isThirdPartyLiability":{"description":"This field is related to `accidentType`. \nWhen `accidentType` is specified, this field indicates whether a third party is liable for the accident.","example":false,"nullable":true,"readOnly":false,"type":"boolean"},"isWorkRelatedIllness":{"description":"Beroepsziekte","example":false,"nullable":false,"readOnly":false,"type":"boolean"},"progress":{"properties":{"currentIncapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":true,"type":"integer"},"endOfAbsence":{"description":"date and reason for the closing/end of the absence","format":"metadata","nullable":true,"properties":{"date":{"description":"The last day of the absence.\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"reason":{"description":"redenhersteld","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":true,"type":"integer"},"value":{"description":"Description of the reason why the absence ended.","example":"Fully recoverd","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"readOnly":true,"type":"object"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"reintegration":{"nullable":true,"properties":{"dateOfFinalizingPlanOfAction":{"description":"The day on which a plan of action (for return to normal work) was finalized.\n","format":"date","nullable":false,"readOnly":false,"type":"string"},"reintegrationGoal":{"format":"metadata","nullable":false,"properties":{"key":{"description":"The key for the reintegration goal. Related to the Wet Verbetering Poortwachter.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"The name of the country","example":"Werkhervatting in de eigen functie","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"object"},"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"},"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Conflict"},"500":{"description":"Internal Server Error"}},"summary":"Edit the details of a Absence","tags":["Absence"]}},"/providers/employers/employees/absences/{absenceId}/absencecontactHistory":{"get":{"description":"__Activity name :__ GetAbsenceContactHistoryByAbsenceId\n\nGet the contacts history for a specific absence (verzuimmelding).\n","operationId":"GetAbsenceContactsHistoryByAbsenceId","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.820Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.820Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Contact history for an absence","tags":["Contact history"]},"post":{"description":"__Activity name :__ PostAbsenceContactHistoryByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n","operationId":"PostAbsenceContactHistoryByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2018-01-01":{"schema":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.821Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}}}},"description":"Add a record to the contact history for an absence.","required":true},"responses":{"201":{"content":{"application/json;version=2018-01-01":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"contactDate":{"description":"The date on which the contact was initiated.","example":"2025-08-15T13:53:41.821Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"contactMethod":{"description":"The method of contacting the person\n","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the method of contacting the employee","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the method of contact.","example":"e-mail","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"summary":{"description":"Summary of the contact.\n","maxLength":4000,"minLength":1,"nullable":true,"readOnly":false,"type":"string"}}}},"type":"object"}]}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Create a contact history for an Absence","tags":["Contact history"]}},"/providers/employers/employees/absences/{absenceId}/absenceprogress":{"get":{"description":"__Activity name :__ GetAbsenceProgressByAbsenceId\n\nGet a list of absence progress (verzuimverloop) for a specific absence (verzuimmelding).\n","operationId":"GetAbsenceProgressByAbsenceId","parameters":[{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}},{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Filter the collection","in":"query","name":"filter","required":false,"schema":{"example":"cancellationPeriodTimeUnit.key eq 4","type":"string"}},{"description":"Order the collection on one or more fields","in":"query","name":"orderBy","required":false,"schema":{"example":"-companyName,address.houseNumber","pattern":"^-?\\w+(,-?\\w+)*$","type":"string"}},{"description":"Specifies which page should be returned","in":"query","name":"pageNumber","required":false,"schema":{"default":1,"example":2,"format":"int32","type":"integer"}},{"description":"Specifies the number of objects per page","in":"query","name":"pageSize","required":false,"schema":{"default":250,"example":20,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.821Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}},"type":"array"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"data to be used for paging","properties":{"currentPage":{"description":"Current page returned in the response","example":2,"type":"integer"},"pageSize":{"description":"Number of records in the response","example":250,"type":"integer"},"totalPages":{"description":"Number of pages available","example":3,"type":"integer"},"totalSize":{"description":"Total number of records, taking into account the given filter.","example":650,"type":"integer"}},"type":"object"},{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"_embedded":{"items":{"properties":{}},"type":"array"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"List of absence progress for an absence","tags":["Absence Progress"]},"post":{"description":"__Activity name :__ PostAbsenceProgressByAbsenceId\n\n__Metadata :__ Possible options for fields of the type 'metadata' can be acquired (GET) by adding `/metadata` to the POST URL.\n\n__Defaults :__ Default values for a new object can be acquired by adding `/defaults' to the POST URL. \n\nAdd an Absence Progress (=Ziekteverloop) for an employee. As is common with closed chain entities, the endDate of the previous record will be filled depending on the startDate of the new one.\n\nPractically this means that a full recovery notification has been performed. \n","operationId":"PostAbsenceProgressByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.821Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}}},"description":"Add an Absence Progress for an Absence.","required":true},"responses":{"201":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{"comments":{"description":"Free text field to register any relevant information.","example":"Lorem ipsum dolor sit amet, id nibh adhuc omnium vix, ne nec eius inani aliquip.","maxLength":4000,"nullable":true,"readOnly":false,"type":"string"},"endDate":{"description":"The last day that the `incapacityPercentage` is active.
\n","format":"date","nullable":true,"readOnly":true,"type":"string"},"id":{"description":"The unique identifier of an object (GUID/UUID)","example":"b14acd0d-75d7-4fc8-8b22-4a3924585cab","format":"uuid","nullable":false,"pattern":"^[{(]?[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$","readOnly":true,"type":"string"},"incapacityPercentage":{"description":"percentage of not being able to work","example":100,"maximum":100,"minimum":1,"nullable":false,"readOnly":false,"type":"integer"},"startDate":{"description":"start dat of the incapacityPercentage","example":"2025-08-15T13:53:41.821Z","format":"date","nullable":false,"readOnly":false,"type":"string"},"typeOfWorkResumption":{"description":"The type of work the work the employee is fulfilling when partly returning to work.","format":"metadata","nullable":true,"properties":{"key":{"description":"The key of the type of work resumption. Possible values can be acquired via the metadata endpoint.\n","example":2,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the type of work resumption.\n","example":"Eigen werk met aanpassing","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}}}},"type":"object"}]}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Create an Absence Progress for an Absence","tags":["Absence Progress"]}},"/providers/employers/employees/absences/{absenceId}/closeabsence":{"patch":{"description":"__Activity name :__ PatchCloseAbsenceByAbsenceId\n\nA succesfull call to this endpoint will close the absence and the underlying absence progress (with an empty endDate). \n","operationId":"PatchCloseAbsenceByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"properties":{"endOfAbsence":{"description":"date and reason for the closing/end of the absence","format":"metadata","nullable":false,"properties":{"date":{"description":"The last day of the absence. Could also be the last day of employment if employment was to be ended.\n","format":"date","nullable":false,"readOnly":false,"type":"string"},"reason":{"description":"redenhersteld","format":"metadata","nullable":false,"properties":{"key":{"description":"The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint.","example":1,"format":"int32","nullable":false,"readOnly":false,"type":"integer"},"value":{"description":"Description of the reason why the absence ended.","example":"Fully recoverd","maxLength":50,"nullable":false,"readOnly":true,"type":"string"}},"type":"object"}},"readOnly":false,"type":"object"}}}}},"description":"The request body contains an object containing fields related to closing of an absence.","required":true},"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for ","type":"string"},"id":{"description":"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","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"BrokenBusinessRule","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"properties":{},"type":"object"}},"type":"object"}]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Authorization has been denied for this request.","type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Insufficient rights for this request, reason \\\"User doesn't have rechten to perform activity for the given Id.\\\"","type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"Close an absence","tags":["Absence"]}},"/providers/employers/employees/absences/{absenceId}/reopenabsence":{"patch":{"description":"__Activity name :__ PatchReopenAbsenceByAbsenceId\n\nWhen performing a succesfull call to this endpoint, then the absence and the underlying absence progress will we reopend.\nBoth `endOfAbsenceDate` and `endOfAbsenceReason` will be set to null\n","operationId":"PatchReopenAbsenceByAbsenceId","parameters":[{"description":"The unique identifier of an absence","in":"path","name":"absenceId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"A valid Bearer token for authorizing the request.","in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer ","pattern":"^Bearer\\s[\\w-]+$","type":"string"}},{"description":"The accept header is used to influence what type of output is returned and in most cases the version of the output","in":"header","name":"Accept","required":true,"schema":{"example":"application/json;version=2018-01-01","type":"string"}}],"requestBody":{"content":{"application/json;version=2020-03-16":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json;version=2020-03-16":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a warning indacateds that the given payload is valide, however take notice of the warning this might ifluence behavour.","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"","type":"string"},"id":{"description":"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 ","example":"904d6856-6034-4624-bcbc-886188c115c5","format":"uuid","nullable":true,"type":"string"},"properties":{"description":"An array that can contain additional information","items":{"type":"string"},"minimum":0,"type":"array"},"type":{"description":"Indication of the type of message.\nSee [the general documentation for more information](./#section/Response/Messages)","example":"Warning","type":"string"}}},"type":"array"}},"type":"object"},{"properties":{"content":{"type":"object"}},"type":"object"}]}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"allOf":[{"description":"The version of the resource","properties":{"version":{"properties":{"obsoleteDate":{"description":"The date (can be null) on which the `resourceVersion` is no longer supported/available","format":"date","nullable":true,"type":"string"},"resourceVersion":{"description":"The resource version of the object in the response","example":"2025-08-15T13:53:41.821Z","format":"date","type":"string"}},"type":"object"}},"type":"object"},{"description":"a broken business rule indacateds that the given payload is not valide","minimum":0,"properties":{"messages":{"items":{"properties":{"code":{"description":"Identifying code for the message","example":12,"format":"int32","type":"integer"},"description":{"description":"Describes the message","example":"Invalid value for